NdbDictionary

没有任何

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

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

下表列出了该类的公共方法以及每个方法的用途或用途：

这些是Column 该类的公共类型：

属性存储格式可以是固定的，也可以是可变的。

下表显示了可能的值以及说明：

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

Column使用 NDB API 创建的 A对 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指定字符集和排序规则的结构的指针。这与 MySQLMY_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

没有。

布尔值：true如果列可以设置为NULL，否则 为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 7.3.10 和 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
    )

这个方法有两个参数：一个值指针 buf；和数据的长度 len，作为有效字节数。对于固定大小的类型，这是类型大小。对于可变长度类型，由 指向的前导 1 或 2 个字节buffer还包含该类型正常的大小信息。

0 成功，1 失败..

此方法获取 blob 列的内联大小，即要存储在表的 blob 属性中的初始字节数。这部分通常保存在主存中，可以被索引和解释。

此方法仅适用于 blob 列。

使用此方法对列所做的更改对 MySQL 不可见。从 NDB 8.0.30 开始，您可以通过将列注释设置为or的一部分来更改mysql客户端中 blob 列的内联大小。有关详细信息，请参阅 NDB_COLUMN 选项。 BLOB_INLINE_SIZECREATE TABLEALTER TABLE

void setInlineSize
    (
      int size
    )

该整数size是 blob 列的新内联大小。

没有。

此方法设置列的长度。对于变长数组，这是最大长度；否则就是数组长度。

使用此方法对列所做的更改对 MySQL 不可见。

void setLength
    (
      int length
    )

此方法采用单个参数——整数值 length是列的新长度。

没有。

此方法用于设置列的名称。

setName()是唯一 Column一个其结果从 MySQL 服务器可见的方法。MySQL 看不到使用 NDB API 对现有列所做的任何其他更改。

void setName
    (
      const char* name
    )

此方法采用单个参数——列的新名称。

此方法无。

此方法切换列的可空性。

使用此方法对列所做的更改对 MySQL 不可见。

void setNullable
    (
      bool nullable
    )

一个布尔值。使用true可以将NULLs 插入到列中；如果nullable是 false，则此方法执行的操作相当于NOT NULL在 MySQL 中将列更改为。

没有。

此方法可以将列添加到其所属表的分区键，或从表的分区键中删除列。

使用此方法对列所做的更改对 MySQL 不可见。

有关其他信息，请参阅 Column::getPartitionKey()。

void setPartitionKey
    (
      bool enable
    )

单个参数enable是布尔值。传递true给此方法使列成为表分区键的一部分；如果enable是 false，则该列将从分区键中删除。

没有。

此方法设置 blob 列的 blob 部分大小，即要存储在 blob 表的每个元组中的字节数。

此方法仅适用于 blob 列。

使用此方法对列所做的更改对 MySQL 不可见。您可以通过将列注释中的选项设置为or语句的一部分，将 blob 列的 blob 部分大小增加到mysql或其他 MySQL 客户端NDB(13948)支持的最大值。请参阅 NDB_COLUMN 选项。 MAX_BLOB_PART_SIZECREATE TABLEALTER TABLE

void setPartSize
    (
      int size
    )

整数size是要存储在 blob 表中的字节数。对此值使用零意味着只能存储内联字节，实际上使该列成为 type TINYBLOB。

没有。

此方法可用于设置小数列的精度。

此方法仅适用于十进制列。

使用此方法对列所做的更改对 MySQL 不可见。

void setPrecision
    (
      int precision
    )

此方法采用单个参数——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。

下表显示了可能的值以及说明：