NdbDictionary

无

每个 Column 实例都以其类型为特征，该类型由许多类型说明符确定

这些类型通常对应于 MySQL 数据类型及其变体。数据格式与 MySQL 中的格式相同。NDB API 不提供构建此类格式的支持；但是，它们由 NDB 内核检查。

下表列出了此类的公共方法以及每个方法的用途或使用场景

这些是 Column 类的公共类型

属性存储格式可以是固定格式或可变格式。

下表显示了可能的值以及描述

您可以使用类构造函数创建一个新的 Column 或复制现有的 Column。

使用 NDB API 创建的 Column 对 MySQL 服务器是不可见的。

NDB API 以区分大小写的方式处理列名。例如，如果您创建了一个名为 “myColumn” 的列，您将无法使用 “Mycolumn” 作为名称来访问它。您可以通过一致地使用大写或小写来命名所有列，从而减少出错的可能性。

您可以创建一个新的 Column 类实例，也可以复制现有的 Column 对象。这两种方法都将在下面展示

在创建一个新的 Column 实例时，构造函数接受一个参数，即要创建的新列的名称。复制构造函数也接受一个参数 - 在这种情况下，是一个对要复制的 Column 实例的引用。

一个 Column 对象。

Column 类析构函数不接受任何参数，也不返回任何值 (void)。

此方法用于比较两个 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 包含默认值数据的长度，或者在列可为空或没有默认值的情况下包含 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

无.

布尔值：如果列是此列所属表的 primary key 的一部分，则为 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 来更改 blob 列的内联大小，该大小作为 CREATE TABLE 或 ALTER TABLE 的一部分出现在列注释中。有关更多信息，请参阅 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
    )

此方法接受一个参数：列的新名称。

此方法 None。

此方法切换列的可空性。

使用此方法对列进行的更改对 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 不可見。您可以在 mysql 或其他 MySQL 客户端中将 blob 列的 blob 部分大小增加到 NDB 支持的最大值（13948），方法是在 CREATE TABLE 或 ALTER TABLE 语句中设置列注释中的 MAX_BLOB_PART_SIZE 选项。参阅 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 混淆。

下表显示了可能的值以及描述