NdbDictionary

无

Table 类表示 NDB Cluster 数据库中的一个表。此类扩展了 Object 类，该类又 是 NdbDictionary 类的内部类。

可以使用 NDB API 创建独立于 MySQL 服务器的表。但是，通常不建议这样做，因为以这种方式创建的表无法被 MySQL 服务器看到。类似地，可以使用 Table 方法修改现有表，但这些更改（除了重命名表外）对 MySQL 是不可见的。

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

Table 类定义了一个公共类型 SingleUserMode。

向表添加一列。

void addColumn
    (
      const Column& column
    )

对要添加到表的列的引用。

此方法的返回类型为 void，但它确实会创建原始 Column 对象的副本。

此方法计算表的聚合数据。在表被创建并通过 getTableId() 检索之前，需要此方法才能使诸如 getNoOfPrimaryKeys() 之类的聚合方法正常工作。

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 集群中使用 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 和版本。

如果表具有哈希映射，则为真，否则为假。

此方法获取 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 中被移除（错误＃47960，错误＃11756088）。

Object::Type getObjectType
    (
      void
    ) const

无.

返回一个 Object::Type 值。

此方法获取表的对象版本（参见 NDB 架构对象版本）。

virtual int getObjectVersion
    (
      void
    ) const

无.

表的对象版本，作为整数。

此方法获取表的partition balance 方案（片段计数类型）。

在 NDB 7.5 之前，此方法称为 getFragmentCountType()。

Object::PartitionBalance getPartitionBalance
    (
      void
    ) const

无.

分区平衡方案，作为 Object::PartitionBalance 类型的值。

此方法获取表的partition balance 方案（片段计数类型），并将其作为字符串返回。

在 NDB 7.5 之前，此方法称为 getFragmentCountTypeString()。

const char* getPartitionBalanceString
    (
      void
    ) const

无.

分区平衡方案，作为字符串值。

获取表的partition ID，根据其哈希值。

Uint32 getPartitionId
    (
      Uint32 hashvalue
    ) const

一个 hashvalue。请注意，如果表尚未实际检索（例如，使用 getTableId()），则结果可能不准确或无用。

与 hashvalue 对应的partition 的标识符。

此方法用于获取表的primaryKey名称。

const char* getPrimaryKey
    (
      int no
    ) const

无.

primaryKey的名称，一个字符串（字符指针）。

此方法获取与表关联的范围或列表数据。

const void* getRangeListData
    (
      void
    ) const

无.

指向数据的指针。

此方法获取表范围或列表数组的大小。

Uint32 getRangeListDataLen
    (
      void
    ) const

无.

列表或范围数组的长度，作为整数。

检查行校验和指示器是否已设置。

bool getRowChecksumIndicator
    (
      void
    ) const

无.

一个 true 或 false 值。

检查行 GCI 指示器是否已设置。

bool getRowGCIIndicator
    (
      void
    ) const

无.

一个 true 或 false 值。

获取此表中行的 size。这是可以存储在表单行中的（最大）数据量，不包括存储在表外部的任何 blob 数据。

int getRowSizeInBytes
    (
      void
    ) const

无.

行的 size，以字节为单位。

获取表的单用户模式。

enum SingleUserMode getSingleUserMode
    (
      void
    ) const

无.

一个 SingleUserMode 值。

此方法获取表的 ID。

int getTableId
    (
      void
    ) const

无.

表的 ID，作为整数。

此方法以两种方式使用：获取此表所属的tablespace名称；验证给定的tablespace是否为此表使用。

要获取正在使用的tablespace的名称，请在不带任何参数的情况下调用

const char* getTablespace
    (
      void
    ) const

要确定tablespace是否为由给定 ID 和版本指示的tablespace，请提供这些参数，如下所示

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

参数的数量和类型取决于此方法的使用方式

返回类型取决于方法的调用方式

此方法获取表的tablespace 数据（ID 和版本）。

const void* getTablespaceData
    (
      void
    ) const

无.

指向数据的指针。

此方法用于获取表tablespace 数据的长度。

Uint32 getTablespaceDataLen
    (
      void
    ) const

无.

数据的长度，作为 32 位无符号整数。

此方法获取指向表片段中使用的tablespace名称的指针。

const void* getTablespaceNames
    (
      void
    )

无.

返回指向tablespace名称数据的指针。

此方法获取 getTablespaceNames() 返回的tablespace名称数据的长度。（参见 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。任何其他值都表示失败；在这种情况下，该值是指示错误类型的错误代码。

强制表分配可变 size 的部分，以允许对表执行在线操作，即使它没有可变 size 的列。有关 NDB Cluster 中在线操作的更多信息，请参见 NDB Cluster 中使用 ALTER TABLE 进行在线操作。

void setForceVarPart
    (
      bool force
    )

将 force 设置为 true 使用，以使表具有可变 size 部分。

无.

设置表片段的数量。

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 的唯一一个 set*() 方法，其效果对 MySQL 可见。

void setName
    (
      const char* name
    )

name 是表的（新）名称。

无.

此方法无法按预期工作，并在 NDB 7.5.0 中被移除（错误＃47960，错误＃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 也将被设置。