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，失败返回任何其他值。nonzer4o 值应解释为错误类型的错误代码。

表是否被强制分配可变大小的部分，而不管表实际上是否有任何可变大小的列。这是允许随后将列在线添加到表中所必需的（请参阅 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() and setExtraMetadata() 。

const void* getFrmData
    (
      void
    ) const

没有。

指向.FRM数据的指针。

获取表的 .FRM文件数据的长度，以字节为单位。

MySQL 8.0 和 NDB 8.0 不再使用 .FRM文件，而是使用 MySQL 数据字典来存储表元数据；因此，从 NDB 8.0.27 开始，此方法已被弃用，并且会在未来的 NDB 版本中删除。对于读取和写入表元数据，请改用 getExtraMetadata() and setExtraMetadata() 。

Uint32 getFrmLength
    (
      void
    ) const

没有。

文件数据的长度.FRM（无符号 32 位整数）。

获取用于此表的哈希映射。

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

表 ID 和版本。

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

此方法获取 KValue，这是一个哈希参数，目前仅限于 value 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 Schema Object Versions）。

virtual int getObjectVersion
    (
      void
    ) const

没有。

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

该方法获取表的分区平衡方案（分片计数类型）。

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

Object::PartitionBalance getPartitionBalance
    (
      void
    ) const

没有。

分区平衡方案，作为 type 的值 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()。（ 参见表::getTablespaceNames()。）

Uint32 getTablespaceNamesLen
    (
      void
    ) const

没有。

返回名称数据的长度，以字节为单位，作为 32 位无符号整数。

用于确定表中是否有任何列是使用 以外的默认值定义的 NULL。

要读取和写入默认列值，请使用 Column::getDefaultValue() 和 Column::setDefaultValue()。

bool hasDefaultValues
    (
      void
    ) const

没有。

如果表中有任何具有默认值true的非列，则 返回，否则返回。 NULLfalse

此方法设置一个指示器，用于确定表是否使用默认分区数。

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
    )

使用 with forceset to 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() and setExtraMetadata() 。

void setFrm
    (
      const void* data,
      Uint32      len
    )

此方法采用以下两个参数：

没有。

为表设置哈希映射。

int setHashMap
    (
      const class HashMap &
    )

对哈希映射的引用。

成功返回0；失败时，返回 -1 并设置错误。

这设置了KValue一个散列参数。

void setKValue
    (
      int kValue
    )

kValue是一个整数。当前唯一允许的值是6. 在未来的版本中，这可能会成为一个可变参数。

没有。

设置表的线性散列标志。请参阅 表::getLinearFlag()。

void setLinearFlag
    (
      Uint32 flag
    )

是flag一个 32 位无符号整数。

没有。

切换表的日志记录状态。请参阅 表::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()。

没有。

此方法设置表的名称。

这是MySQL 可见其效果 的唯一 方法。set*()Table

void setName
    (
      const char* name
    )

name是表的（新）名称。

没有。

此方法未按预期工作，并已在 NDB 7.5.0 中删除（Bug #47960，Bug #11756088）。

void setObjectType
    (
      Object::Type type
    )

想要的对象type。这必须是Object::TypeType中列出的值 之一。

没有。

设置表的分区平衡方案。

在 NDB 7.5 之前，此方法称为 setFragmentCountType().

void setPartitionBalance
    (
      Object::PartitionBalance scheme
    )

scheme是用于表的分区平衡方案。这是 type 的值 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。

没有。

为表设置 a 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也已设置。