NdbDictionary

無

Table 類別表示 NDB Cluster 資料庫中的表格。此類別延伸了 Object 類別，而該類別又是 NdbDictionary 類別的內部類別。

可以使用 NDB API 獨立於 MySQL 伺服器建立表格。但是，通常不建議這樣做，因為以這種方式建立的表格無法被 MySQL 伺服器看到。同樣地，可以使用 Table 方法修改現有表格，但這些變更 (重新命名表格除外) 對 MySQL 不可見。

下表列出此類別的公用方法以及每個方法的目的或用法

Table 類別定義單一公用類型 SingleUserMode。

將欄位新增至表格。

void addColumn
    (
      const Column& column
    )

要新增至表格的欄位參考。

此方法的回傳類型為 void，但它會建立原始 Column 物件的副本。

此方法會計算表格的彙總資料。必須先執行此方法，getNoOfPrimaryKeys() 等彙總方法才能正常運作，然後才能建立表格並透過 getTableId() 擷取表格。

int aggregate
    (
      struct NdbError& error
    )

對 NdbError 物件的參考。

整數，如果成功，則值為 0，如果表格處於不一致的狀態，則值為 -1。在後者的情況下，也會設定 error。

建立 Table 執行個體。Table 建構函式有兩個版本，一個用於建立新執行個體，另一個用於複製建構函式。

使用此方法在 NDB API 中建立的表格無法從 MySQL 存取。

新執行個體

Table
    (
      const char* name = ""
    )

複製建構函式

Table
    (
      const Table& table
    )

對於新執行個體，這是要建立的表格名稱。對於複製，這是要複製的表格參考。

Table 物件。

virtual ~Table()

此方法用於比較 Table 的一個執行個體與另一個執行個體。

bool equal
    (
      const Table& table
    ) const

要與目前執行個體比較的 Table 物件參考。

如果兩個表格相同，則為 true，否則為 false。

此方法用於取得欄位定義，並提供欄位的索引或名稱。

此方法可以使用欄位 ID 或欄位名稱來叫用，如此處所示

Column* getColumn
    (
      const int AttributeId
    )

Column* getColumn
    (
      const char* name
    )

以下之一：欄位在表格中的索引（如同欄位的 getColumnNo() 方法傳回），或欄位的名稱。

具有指定索引或名稱的欄位指標。如果沒有這樣的欄位，則此方法會傳回 NULL。

此方法用於找出表格是否使用預設的分割區數量。

Uint32 getDefaultNoPartitionsFlag
    (
      void
    ) const

無.

32 位元不帶正負號的整數。

取得並解壓縮此表格的額外中繼資料。

此方法是在 NDB 8.0 中新增的。

int getExtraMetadata
    (
      Uint32& version,
      void** data,
      Uint32* length
    ) const

此方法採用以下三個參數

如果成功，則傳回 0，如果失敗，則傳回任何其他值。非零值應解譯為錯誤類型的錯誤碼。

無論表格實際上是否有任何可變大小的欄位，表格是否強制配置可變大小的部分。這是為了允許後續將欄位線上新增至表格（請參閱使用 NDB Cluster 中的 ALTER TABLE 進行線上作業）。

bool getForceVarPart
    (
      void
    ) const

無.

當強制表格配置可變大小的部分時為 true。

此方法會取得表格中的片段數量。

Uint32 getFragmentCount
    (
      void
    ) const

無.

表格片段數量，為 32 位元不帶正負號的整數。

此方法會取得表格的片段資料（ID、狀態和節點群組）。

const void* getFragmentData
    (
      void
    ) const

無.

要讀取的資料指標。

以位元組為單位取得要讀取的表格片段資料的長度。

Uint32 getFragmentDataLen
    (
      void
    ) const

無.

要讀取的位元組數，為 32 位元不帶正負號的整數。

此方法會擷取儲存指定片段的節點清單。

Uint32 getFragmentNodes
    (
      Uint32 fragmentId,
      Uint32* nodeIdArrayPtr,
      Uint32 arraySize
    ) const

此方法採用以下三個參數

傳回值 0 表示錯誤；否則，這是表格片段數量，為 32 位元不帶正負號的整數。

此方法會取得表格的片段類型。

FragmentType getFragmentType
    (
      void
    ) const

無.

Object::FragmentType 值。

從與表格相關聯的 .FRM 檔案取得資料。

MySQL 8.0 和 NDB 8.0 不再使用 .FRM 檔案，而是使用 MySQL 資料字典來儲存表格中繼資料；因此，從 NDB 8.0.27 開始，此方法已被棄用，並可能在未來的 NDB 版本中移除。若要讀取和寫入表格中繼資料，請改用 getExtraMetadata() 和 setExtraMetadata()。

const void* getFrmData
    (
      void
    ) const

無.

指向 .FRM 資料的指標。

取得表格 .FRM 檔案資料的長度（以位元組為單位）。

MySQL 8.0 和 NDB 8.0 不再使用 .FRM 檔案，而是使用 MySQL 資料字典來儲存表格中繼資料；因此，從 NDB 8.0.27 開始，此方法已被棄用，並可能在未來的 NDB 版本中移除。若要讀取和寫入表格中繼資料，請改用 getExtraMetadata() 和 setExtraMetadata()。

Uint32 getFrmLength
    (
      void
    ) const

無.

.FRM 檔案資料的長度（一個無號 32 位元整數）。

取得用於此表格的雜湊映射。

bool getHashMap
    (
      Uint32* id = 0,
      Uint32* version = 0
    ) const

表格 ID 和版本。

如果表格具有雜湊映射，則為 True，否則為 False。

此方法取得 KValue，這是一個雜湊參數，目前限制為值 6。在未來的版本中，可能會將此參數設定為其他值。

int getKValue
    (
      void
    ) const

無.

一個整數（目前總是 6）。

此方法擷取表格線性雜湊旗標的值。

bool getLinearFlag
    (
      void
    ) const

無.

如果設定了旗標，則為 true，否則為 false。

此類別用於檢查表格是否記錄到磁碟上，也就是說，它是永久表格還是暫時表格。

bool getLogging
    (
      void
    ) const

無.

傳回布林值。如果此方法傳回 true，則會在表格上執行完整檢查點和記錄。如果傳回 false，則表格為暫時表格，且不會記錄到磁碟上；在系統重新啟動時，表格仍然存在並保留其定義，但它將會是空的。預設記錄值為 true。

此方法傳回當本機雜湊表中的容器開始分割時的載入因數（一個雜湊參數）。

int getMaxLoadFactor
    (
      void
    ) const

無.

一個最大值為 100 的整數。當傳回最大值時，表示已最佳化記憶體使用量。較小的值表示每個容器中儲存的資料較少，這表示可以更快地找到金鑰，但會消耗更多記憶體。

此方法取得表格可以容納的最大列數。這用於計算分割區的數量。

Uint64 getMaxRows
    (
      void
    ) const

無.

最大表格列數，以 64 位元無號整數表示。

此方法取得開始縮減雜湊表時的載入因數值。這應該始終小於 getMaxLoadFactor() 傳回的值。

int getMinLoadFactor
    (
      void
    ) const

無.

以整數表示的百分比；請參閱 Table::getMaxLoadFactor()。

此方法取得表格可以容納的最小列數，用於計算分割區的數量。

Uint64 getMinRows
    (
      void
    ) const

無.

最小表格列數，以 64 位元無號整數表示。

取得表格的名稱。

const char* getName
    (
      void
    ) const

無.

表格的名稱（字串）。

此方法用於取得表格中的自動遞增欄位數。

int getNoOfAutoIncrementColumns
    (
      void
    ) const

無.

一個整數，表示表格中自動遞增欄位的數量。

此方法用於取得表格中的欄位數。

int getNoOfColumns
    (
      void
    ) const

無.

一個整數，表示表格中的欄位數。

此方法會找出表格中的主鍵欄位數。

int getNoOfPrimaryKeys
    (
      void
    ) const

無.

一個整數，表示表格中的主鍵欄位數。

此方法取得表格的物件 ID。

virtual int getObjectId
    (
      void
    ) const

無.

物件 ID 以整數形式傳回。

此方法取得表格的狀態。

virtual Object::Status getObjectStatus
    (
      void
    ) const

無.

一個 Object::Status 值。

此方法無法按預期運作，並在 NDB 7.5.0 中移除（Bug #47960, Bug #11756088）。

Object::Type getObjectType
    (
      void
    ) const

無.

傳回一個 Object::Type 值。

此方法取得表格的物件版本（請參閱 NDB 綱要物件版本）。

virtual int getObjectVersion
    (
      void
    ) const

無.

表格的物件版本，以整數表示。

此方法取得表格的分割區平衡配置（片段計數類型）。

在 NDB 7.5 之前，此方法稱為 getFragmentCountType()。

Object::PartitionBalance getPartitionBalance
    (
      void
    ) const

無.

分割區平衡配置，作為 Object::PartitionBalance 類型的值。

此方法取得表格的分割區平衡配置（片段計數類型），並將其以字串形式傳回。

在 NDB 7.5 之前，此方法稱為 getFragmentCountTypeString()。

const char* getPartitionBalanceString
    (
      void
    ) const

無.

分割區平衡配置，作為字串值。

給定雜湊值，取得表格分割區 ID。

Uint32 getPartitionId
    (
      Uint32 hashvalue
    ) const

一個 hashvalue。請注意，如果實際上沒有擷取表格（例如，使用 getTableId()），則結果可能不準確或無用。

對應於 hashvalue 的分割區識別碼。

此方法用於取得表格主鍵的名稱。

const char* getPrimaryKey
    (
      int no
    ) const

無.

主鍵的名稱，一個字串（字元指標）。

此方法取得與表格相關聯的範圍或清單資料。

const void* getRangeListData
    (
      void
    ) const

無.

指向資料的指標。

此方法取得表格範圍或清單陣列的大小。

Uint32 getRangeListDataLen
    (
      void
    ) const

無.

清單或範圍陣列的長度，以整數表示。

檢查是否已設定資料列總和檢查碼指示器。

bool getRowChecksumIndicator
    (
      void
    ) const

無.

一個 true 或 false 值。

檢查是否已設定資料列 GCI 指示器。

bool getRowGCIIndicator
    (
      void
    ) const

無.

一個 true 或 false 值。

取得此表格中資料列的大小。這是可以儲存在表格單一列中的（最大）資料量，不包括儲存在表格外部的任何 Blob 資料。

int getRowSizeInBytes
    (
      void
    ) const

無.

資料列的大小，以位元組為單位。

取得表格的單一使用者模式。

enum SingleUserMode getSingleUserMode
    (
      void
    ) const

無.

一個 SingleUserMode 值。

此方法取得表格的 ID。

int getTableId
    (
      void
    ) const

無.

表格 ID，以整數表示。

此方法以兩種方式使用：取得此表格所指派的表格空間名稱；驗證給定的表格空間是否為此表格使用的表格空間。

若要取得表格空間的名稱，請不帶任何引數調用

const char* getTablespace
    (
      void
    ) const

若要判斷表格空間是否為給定 ID 和版本所指示的表格空間，請按照此處所示的方式提供這些作為引數

bool getTablespace
    (
      Uint32* id      = 0,
      Uint32* version = 0
    ) const

參數的數量和類型取決於此方法的使用方式

傳回類型取決於方法的呼叫方式

此方法取得表格的表格空間資料（ID 和版本）。

const void* getTablespaceData
    (
      void
    ) const

無.

指向資料的指標。

此方法用於取得表格表格空間資料的長度。

Uint32 getTablespaceDataLen
    (
      void
    ) const

無.

資料的長度，以 32 位元無號整數表示。

此方法取得指向表格片段中使用的表格空間名稱的指標。

const void* getTablespaceNames
    (
      void
    )

無.

傳回指向表格空間名稱資料的指標。

此方法取得 getTablespaceNames() 傳回的表格空間名稱資料的長度。（請參閱 Table::getTablespaceNames()。）

Uint32 getTablespaceNamesLen
    (
      void
    ) const

無.

以位元組為單位傳回名稱資料的長度，以 32 位元無號整數表示。

用於判斷表格是否有任何定義了預設值而非 NULL 的欄位。

若要讀取和寫入預設欄位值，請使用 Column::getDefaultValue() 和 Column::setDefaultValue()。

bool hasDefaultValues
    (
      void
    ) const

無.

如果表格有任何具有預設值而非 NULL 的欄位，則傳回 true，否則傳回 false。

此方法設定一個指示器，決定是否針對資料表使用預設的分割區數量。

void setDefaultNoPartitionsFlag
    (
      Uint32 indicator
    ) const

此方法接受一個引數 indicator，一個 32 位元無號整數。

無.

儲存此資料表的封裝額外中繼資料。資料會不經任何修改地封裝到給定的 Table 物件的緩衝區中。

於 NDB 8.0 中新增。

int setExtraMetadata
    (
      Uint32 version,
      const void* data,
      Uint32 length
    )

此方法使用的三個參數列於此處：

成功時傳回 0。任何其他值表示失敗；在這種情況下，該值是一個錯誤碼，表示錯誤的類型。

強制資料表配置可變大小的部分，以便即使資料表沒有可變大小的欄位，也能對資料表執行線上操作。如需有關 NDB Cluster 中線上操作的詳細資訊，請參閱在 NDB Cluster 中使用 ALTER TABLE 進行線上操作。

void setForceVarPart
    (
      bool force
    )

將 force 設定為 true 以使資料表擁有可變大小的部分時使用。

無.

設定資料表片段的數量。

void setFragmentCount
    (
      Uint32 count
    )

count 是用於資料表的片段數量。

無.

此方法寫入一個包含以下片段資訊的陣列：

void setFragmentData
    (
      const void* data,
      Uint32      len
    )

此方法接受以下兩個參數：

無.

此方法設定資料表的分散類型。

void setFragmentType
    (
      FragmentType fragmentType
    )

此方法接受一個引數，即一個 Object::FragmentType 值。

無.

此方法用於將資料寫入此資料表的 .FRM 檔案。

MySQL 8.0 和 NDB 8.0 不再使用 .FRM 檔案，而是使用 MySQL 資料字典來儲存表格中繼資料；因此，從 NDB 8.0.27 開始，此方法已被棄用，並可能在未來的 NDB 版本中移除。若要讀取和寫入表格中繼資料，請改用 getExtraMetadata() 和 setExtraMetadata()。

void setFrm
    (
      const void* data,
      Uint32      len
    )

此方法接受以下兩個引數：

無.

設定資料表的雜湊映射。

int setHashMap
    (
      const class HashMap &
    )

雜湊映射的參考。

成功時傳回 0；失敗時傳回 -1 並設定錯誤。

此方法設定 KValue，一個雜湊參數。

void setKValue
    (
      int kValue
    )

kValue 是一個整數。目前唯一允許的值是 6。在未來的版本中，這可能會變成可變參數。

無.

設定資料表的線性雜湊旗標。請參閱 Table::getLinearFlag()。

void setLinearFlag
    (
      Uint32 flag
    )

flag 是一個 32 位元無號整數。

無.

切換資料表的記錄狀態。請參閱 Table::getLogging()。

void setLogging
    (
      bool enable
    )

如果 enable 為 true，則啟用此資料表的記錄；如果為 false，則停用記錄。

無.

此方法設定在本機雜湊表中分割容器時的最大負載因子。

void setMaxLoadFactor
    (
      int max
    )

此方法接受一個參數 max，一個百分比的整數表示法（例如，45 代表 45%）。如需詳細資訊，請參閱 Table::getMaxLoadFactor()。

此值永遠不應大於最小負載因子。

無.

此方法設定資料表可容納的最大列數。

void setMaxRows
    (
      Uint64 maxRows
    )

maxRows 是一個 64 位元無號整數，代表資料表可容納的最大列數。

無.

此方法設定開始縮減雜湊表時的最小負載因子。

void setMinLoadFactor
    (
      int min
    )

此方法接受一個參數 min，一個百分比的整數表示法（例如，45 代表 45%）。如需詳細資訊，請參閱 Table::getMinLoadFactor()。

無.

此方法設定資料表的名稱。

這是 Table 中唯一一個其效果對 MySQL 可見的 set*() 方法。

void setName
    (
      const char* name
    )

name 是資料表的新名稱。

無.

此方法無法按預期運作，並在 NDB 7.5.0 中移除（Bug #47960, Bug #11756088）。

void setObjectType
    (
      Object::Type type
    )

所需的物件 type。這必須是 Object::Type 中列出的 Type 值之一。

無.

設定資料表的分割區平衡配置。

在 NDB 7.5 之前，此方法稱為 setFragmentCountType()。

void setPartitionBalance
    (
      Object::PartitionBalance scheme
    )

scheme 是用於資料表的分割區平衡配置。這是一個類型為 PartitionBalance 的值。

無.

此方法設定一個陣列，其中包含將範圍值和清單值對應至片段的資訊。這本質上是一個排序的映射，由片段 ID/值對組成。對於範圍分割區，每個片段都有一個配對。對於清單分割區，它可以是任意數量的配對，但至少與片段一樣多的配對。

void setRangeListData
    (
      const void* data,
      Uint32      len
    )

此方法需要以下兩個參數：

無.

設定列總和檢查碼指示器。

void setRowChecksumIndicator
    (
      bool value
    ) const

一個 true 或 false value。

無.

設定列 GCI 指示器。

void setRowGCIIndicator
    (
      bool value
    ) const

一個 true 或 false value。

無.

為資料表設定 SingleUserMode。

void setSingleUserMode
    (
      enum SingleUserMode
    )

一個 SingleUserMode 值。

無.

強制將資料表的狀態設為無效。

void setStatusInvalid
    (
      void
    ) const

無.

無.

此方法設定資料表的表空間。

請參閱 第 2.3.28 節，「表空間類別」。

使用表空間的名稱

void setTablespace
    (
      const char* name
    )

使用 Tablespace 物件

void setTablespace
    (
      const class Tablespace& tablespace
    )

此方法可以使用單一引數呼叫，該引數可以是以下兩種類型之一：

無.

此方法設定每個片段的表空間資訊，並包括表空間 ID 和表空間版本。

void setTablespaceData
    (
      const void* data,
      Uint32      len
    )

此方法需要以下兩個參數：

無.

設定資料表片段所使用的表空間名稱。

void setTablespaceNames
    (
      const void* data
      Uint32      len
    )

此方法接受以下兩個參數：

無.

SingleUserMode 指定單一使用者模式生效時資料表的存取權限。

下表顯示 SingleUserMode 的可能值及其描述：

此方法會驗證新資料表在建立之前的定義，執行 Table::aggregate() 方法，並執行額外檢查。validate() 在建立或擷取資料表時會自動呼叫。因此，通常不需要直接呼叫 aggregate() 或 validate()。

您應了解，即使在呼叫 validate() 方法之後，仍然可能存在只能在實際建立資料表時由 NDB 核心偵測到的錯誤。

int validate
    (
      struct NdbError& error
    )

對 NdbError 物件的參考。

整數，如果成功，則值為 0，如果表格處於不一致的狀態，則值為 -1。在後者的情況下，也會設定 error。