NdbDictionary

無

Column 的每個執行個體都以其類型為特徵，該類型由許多類型規範決定

這些類型通常對應於 MySQL 資料類型及其變體。資料格式與 MySQL 中的相同。NDB API 不支援建構此類格式；但是，它們會由 NDB 核心檢查。

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

這些是 Column 類別的公用類型

屬性儲存格式可以是固定或變動的。

下表顯示可能的值及其說明

您可以使用類別建構函式建立新的 Column 或複製現有的欄位。

使用 NDB API 建立的 Column 對 MySQL 伺服器來說是不可見的。

NDB API 以區分大小寫的方式處理欄位名稱。例如，如果您建立一個名為 「myColumn」 的欄位，您將無法稍後使用名稱 「Mycolumn」 來存取它。您可以藉由始終使用大寫或小寫字母來命名所有欄位，以減少因欄位名稱大小寫錯誤而產生的錯誤。

您可以建立 Column 類別的新執行個體，或藉由複製現有的 Column 物件。這兩種情況都顯示在此處

在建立 Column 的新執行個體時，建構函式會採用單一引數，即要建立的新欄位的名稱。複製建構函式也會採用一個參數，在此案例中，是對要複製的 Column 執行個體的參考。

Column 物件。

Column 類別解構函式不採用任何引數，且不傳回任何內容 (void)。

此方法用於比較一個 Column 與另一個 Column，以判斷兩個 Column 物件是否相同。

bool equal
    (
      const Column& column
    ) const

equal() 採用單一參數，即對 Column 的執行個體的參考。

如果正在比較的欄位相等，則為 true，否則為 false。

此方法取得欄位的陣列類型。

ArrayType getArrayType
    (
      void
    ) const

無.

ArrayType；請參閱 Column::ArrayType 以取得可能的值。

此方法顯示欄位是否為自動遞增欄位。

bool getAutoIncrement
    (
      void
    ) const

無.

如果欄位是自動遞增欄位，則為 TRUE，如果不是，則為 FALSE。

此方法取得文字欄位所使用的字元集。

此方法僅適用於 Type 值為 Char、Varchar 或 Text 的欄位。

NDB API 以區分大小寫的方式處理欄位名稱；「myColumn」 和 「Mycolumn」 不會被視為參考相同的欄位。建議您始終使用大寫或小寫字母來命名所有欄位，以將因欄位名稱大小寫錯誤而產生錯誤的可能性降至最低。

CHARSET_INFO* getCharset
    (
      void
    ) const

無.

指向指定字元集和定序的 CHARSET_INFO 結構的指標。這與 MySQL MY_CHARSET_INFO 資料結構相同；如需更多資訊，請參閱 MySQL 手冊中的 mysql_get_character_set_info()。

此方法取得欄位在其所屬的表格或索引中的序號。如果欄位是索引的一部分（例如，由 getColumn() 傳回時），它會對應到它在該索引中的位置，而不是在包含索引的表格中的位置。

int getColumnNo
    (
      void
    ) const

無.

欄位編號，以整數表示。

取得欄位的預設值資料。

若要判斷表格是否有任何包含預設值的欄位，請使用 Table::hasDefaultValues()。

const void* getDefaultValue
    (
      unsigned int* len = 0
    ) const

len 保留預設值資料的長度，如果欄位為可為 Null 或沒有預設值，則保留 0。

預設值資料。

此方法擷取 blob 欄位的內嵌大小，也就是要儲存在表格 blob 屬性中的初始位元組數。這部分通常位於主記憶體中，並且可以編製索引。

此方法僅適用於 blob 欄位。

從 NDB 8.0.29 開始，您也可以在 mysql 用戶端中透過查詢 ndbinfo.blobs 表格來取得此資訊。

int getInlineSize
    (
      void
    ) const

無.

blob 欄位的內嵌大小，以整數表示。

此方法取得欄位的長度。這可以是欄位的陣列長度，或對於變動長度的陣列，則是最大長度。

int getLength
    (
      void
    ) const

無.

欄位的（最大）陣列長度，以整數表示。

此方法會傳回呼叫它的欄位的名稱。

NDB API 以區分大小寫的方式處理欄位名稱。例如，如果您擷取特定欄位的名稱 「myColumn」，嘗試使用名稱 「Mycolumn」 來存取此欄位會失敗，並顯示 Column is NULL 或 Table definition has undefined column 等錯誤。您可以藉由始終使用大寫或小寫字母來命名所有欄位，以減少出錯的可能性。

const char* getName
    (
      void
    ) const

無.

欄位的名稱。

此方法用於判斷是否可將欄位設定為 NULL。

bool getNullable
    (
      void
    ) const

無.

布林值：如果可將欄位設定為 NULL，則為 true，否則為 false。

此方法用於檢查欄位是否為表格分割索引鍵的一部分。

分割索引鍵是一組屬性，用於將元組分配到資料節點上。此索引鍵是 NDB 儲存引擎特有的雜湊函式。

其中一個有用的範例是涉及多個倉庫和區域的庫存追蹤應用程式，其中將倉庫 ID 和區域 ID 用作分割索引鍵可能很好。這會將特定區域和倉庫的所有資料放置在相同的儲存節點中。在每個片段的本機，仍會使用完整的主要索引鍵搭配此案例中的雜湊演算法。

如需關於 MySQL 中分割、分割配置和分割索引鍵的詳細資訊，請參閱 MySQL 手冊中的 分割。

唯一支援與 NDB 儲存引擎搭配使用的使用者定義分割類型是金鑰分割，包括線性金鑰分割。

bool getPartitionKey
    (
      void
    ) const

無.

如果欄位是表格分割索引鍵的一部分，則為 true，否則為 false。

此方法用於取得 BLOB 欄位的 blob 部分大小，也就是儲存在 blob 表格之每個元組中的位元組數。

此方法僅適用於 BLOB 欄位。

在 NDB 8.0.29 和更新版本中，您也可以在 mysql 用戶端或其他 MySQL 用戶端中透過查詢 ndbinfo.blobs 表格來取得此資訊。

int getPartSize
    (
      void
    ) const

無.

欄位的部分大小，以整數表示。在 Tinyblob 欄位的情況下，此值為 0 (也就是只會儲存內嵌位元組)。

此方法取得欄位的精確度。

此方法僅適用於十進位欄位。

int getPrecision
    (
      void
    ) const

無.

欄位的精確度，以整數表示。精確度定義為有效位數；如需更多資訊，請參閱 MySQL 手冊中 數值資料類型 中對於 DECIMAL 資料類型的討論。

此方法用於判斷欄位是否為表格主要索引鍵的一部分。

bool getPrimaryKey
    (
      void
    ) const

無.

布林值：如果欄位是此欄位所屬表格的主要索引鍵的一部分，則為 true，否則為 false。

此方法取得用於十進位欄位值的刻度。

此方法僅適用於十進位欄位。

int getScale
    (
      void
    ) const

無.

十進位欄位的刻度，以整數表示。十進位欄位的刻度表示小數點後可儲存的位數。此值可能為 0。如需更多資訊，請參閱 MySQL 手冊中 數值資料類型 中對於 DECIMAL 資料類型的討論。

此函式用於取得欄位的大小。

int getSize
    (
      void
    ) const

無.

欄位的大小 (以位元組為單位，為整數值)。

根據欄位的類型，取得 NdbRecord 的指定欄位所需的空間，如下所示

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

int getSizeInBytesForRecord
    (
      void
    ) const

無.

一個整數（請參閱說明）。

此方法取得欄位的儲存類型。

StorageType getStorageType
    (
      void
    ) const

無.

一個 StorageType 值；有關此類型的更多資訊，請參閱 Column::StorageType。

此方法取得 blob 欄位的條帶大小—也就是說，每個節點群組中要儲存的連續部分數量。

int getStripeSize
    (
      void
    ) const

無.

欄位的條帶大小，以整數表示。

此方法取得欄位的資料類型。

Type getType
    (
      void
    ) const

無.

欄位的 Type (資料類型)。有關可能值的列表，請參閱 Column::Type。

設定欄位的陣列類型。

void setArrayType
    (
      ArrayType type
    )

一個 Column::ArrayType 值。有關更多資訊，請參閱 Column::ArrayType。

無.

使欄位自動遞增（或不遞增）。

void setAutoIncrement
    (
      bool flag
    )

一個布林值：TRUE 使欄位自動遞增；FALSE 移除欄位的此屬性。

無.

設定自動遞增欄位的初始值。

void setAutoIncrementInitialValue
    (
      Uint64 value
    )

欄位的初始值（一個 64 位元整數）。

無.

此方法可用於設定 Char、Varchar 或 Text 欄位的字元集和校對。

此方法僅適用於 Char、Varchar 和 Text 欄位。

使用此方法對欄位所做的變更，MySQL 無法看見。

void setCharset
    (
      CHARSET_INFO* cs
    )

此方法接受一個參數。cs 是指向 CHARSET_INFO 結構的指標。有關更多資訊，請參閱 Column::getCharset()。

無.

如果欄位有預設值，此方法會將欄位值設定為其預設值；否則，它會將欄位設定為 NULL。

若要判斷表格是否有任何包含預設值的欄位，請使用 Table::hasDefaultValues()。

int setDefaultValue
    (
      const void* buf,
      unsigned int len
    )

此方法接受 2 個引數：一個值指標 buf；以及資料的長度 len，以有效位元組數表示。對於固定大小的類型，這是類型大小。對於可變長度類型，buffer 指向的前導 1 或 2 個位元組也包含該類型的正常大小資訊。

成功時為 0，失敗時為 1。

此方法取得 blob 欄位的內嵌大小—也就是說，要儲存在資料表 blob 屬性中的初始位元組數。此部分通常保留在主記憶體中，並且可以編制索引和解譯。

此方法僅適用於 blob 欄位。

使用此方法對欄位所做的變更，MySQL 無法看見。從 NDB 8.0.30 開始，您可以在 mysql 用戶端中，藉由在欄位註解中設定 BLOB_INLINE_SIZE 作為 CREATE TABLE 或 ALTER TABLE 的一部分，來變更 blob 欄位的內嵌大小。有關更多資訊，請參閱 NDB_COLUMN 選項。

void setInlineSize
    (
      int size
    )

整數 size 是 blob 欄位新的內嵌大小。

無.

此方法設定欄位的長度。對於可變長度陣列，這是最大長度；否則，它是陣列長度。

使用此方法對欄位所做的變更，MySQL 無法看見。

void setLength
    (
      int length
    )

此方法接受單一引數—整數值 length 是欄位的新長度。

無.

此方法用於設定欄位的名稱。

setName() 是唯一一個其結果可從 MySQL 伺服器看見的 Column 方法。MySQL 無法看見使用 NDB API 對現有欄位所做的任何其他變更。

void setName
    (
      const char* name
    )

此方法接受單一引數—欄位的新名稱。

此方法 無。

此方法切換欄位的可空性。

使用此方法對欄位所做的變更，MySQL 無法看見。

void setNullable
    (
      bool nullable
    )

一個布林值。使用 true 可以將 NULL 插入到欄位中；如果 nullable 為 false，則此方法會執行與在 MySQL 中將欄位變更為 NOT NULL 等效的操作。

無.

此方法可將欄位新增至其所屬資料表的分割索引鍵，或從資料表的分割索引鍵中移除欄位。

使用此方法對欄位所做的變更，MySQL 無法看見。

有關更多資訊，請參閱 Column::getPartitionKey()。

void setPartitionKey
    (
      bool enable
    )

單一參數 enable 是一個布林值。將 true 傳遞給此方法會使欄位成為資料表分割索引鍵的一部分；如果 enable 為 false，則會從分割索引鍵中移除該欄位。

無.

此方法設定 blob 欄位的 blob 部分大小—也就是說，要儲存在 blob 資料表的每個元組中的位元組數。

此方法僅適用於 blob 欄位。

使用此方法對欄位所做的變更，MySQL 無法看見。您可以藉由在欄位註解中設定 MAX_BLOB_PART_SIZE 選項，作為 CREATE TABLE 或 ALTER TABLE 陳述式的一部分，在 mysql 或其他 MySQL 用戶端中，將 blob 欄位的 blob 部分大小增加到 NDB 支援的最大值 (13948)。請參閱 NDB_COLUMN 選項。

void setPartSize
    (
      int size
    )

整數 size 是要儲存在 blob 資料表中的位元組數。對此值使用零表示只能儲存內嵌位元組，實際上會使欄位的類型為 TINYBLOB。

無.

此方法可用於設定小數欄位的精確度。

此方法僅適用於十進位欄位。

使用此方法對欄位所做的變更，MySQL 無法看見。

void setPrecision
    (
      int precision
    )

此方法接受單一參數—精確度是一個整數，也就是欄位新精確度的值。有關小數精確度和比例的更多資訊，請參閱 Column::getPrecision() 和 Column::getScale()。

無.

此方法用於使欄位成為資料表主索引鍵的一部分，或將其從主索引鍵中移除。

使用此方法對欄位所做的變更，MySQL 無法看見。

void setPrimaryKey
    (
      bool primary
    )

此方法接受單一布林值。如果為 true，則欄位會成為資料表主索引鍵的一部分；如果為 false，則會從主索引鍵中移除該欄位。

無.

此方法可用於設定小數欄位的比例。

此方法僅適用於十進位欄位。

使用此方法對欄位所做的變更，MySQL 無法看見。

void setScale
    (
      int scale
    )

此方法接受單一參數—整數 scale 是小數欄位的新比例。有關小數精確度和比例的更多資訊，請參閱 Column::getPrecision() 和 Column::getScale()。

無.

此方法設定 blob 欄位的條帶大小—也就是說，每個節點群組中要儲存的連續部分數量。

此方法僅適用於 blob 欄位。

使用此方法對欄位所做的變更，MySQL 無法看見。

void setStripeSize
    (
      int size
    )

此方法接受單一引數。整數 size 是欄位的新條帶大小。

無.

設定欄位的儲存類型。

void setStorageType
    (
      StorageType type
    )

一個 Column::StorageType 值。有關更多資訊，請參閱 Column::StorageType。

無.

此方法設定欄位的 Type (資料類型)。

setType() 會將所有欄位屬性重設為其（與類型相關的）預設值；當您變更給定欄位的屬性時，它應該是您呼叫的第一個方法。

使用此方法對欄位所做的變更，MySQL 無法看見。

void setType
    (
      Type type
    )

此方法接受單一參數—欄位的新 Column::Type。預設值為 Unsigned。有關所有允許值的列表，請參閱 Column::Type。

無.

給定欄位使用的儲存類型可以是在記憶體中或在磁碟上。儲存在磁碟上的欄位表示總體所需的 RAM 較少，但這類欄位無法編制索引，並且存取速度可能慢得多。預設值為 StorageTypeMemory。

下表顯示可能的值及其說明

Column 物件的資料類型與 MySQL 使用的資料類型類似。類型 Tinyint、Tinyintunsigned、Smallint、Smallunsigned、Mediumint、Mediumunsigned、Int、Unsigned、Bigint、Bigunsigned、Float 和 Double（也就是說，在列舉值表格中列出的順序中，從 Tinyint 到 Double 的類型）可以用於陣列中。

請勿將 Column::Type 與 Object::Type 混淆。

下表顯示可能的值及其說明