NdbDictionary

无

此类表示 NDB Cluster 表列上的索引。它是 NdbDictionary 类的子类，使用 Object 类。

如果使用 NDB API 创建或更改索引，MySQL 将无法看到这些修改。唯一的例外是使用 Index::setName() 重命名索引。

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

Index 定义了一个公共类型，即 Type 类型。

这用于创建 Index 的新实例。

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

Index
    (
      const char* name = ""
    )

新索引的名称。可以创建一个没有名称的索引，然后使用 setName() 为其分配名称。请参阅 Index::setName()。

Index 的新实例。

析构函数 (~Index()) 作为虚方法提供。

此方法可用于向索引添加列。

列的顺序与它们添加到索引的顺序相匹配。但是，这仅适用于有序索引。

void addColumn
    (
      const Column& c
    )

要添加到索引的列的引用 c。

无.

此方法的工作方式与 addColumn() 相同，只是它将列的名称作为参数。请参阅 Index::getColumn()。

void addColumnName
    (
      const char* name
    )

要添加到索引的列的 name，作为常量字符指针。

无.

此方法用于一次向索引定义添加多个列名。

与 addColumn() 和 addColumnName() 方法一样，索引按添加顺序编号。这通常只对有序索引重要。

void addColumnNames
    (
      unsigned     noOfNames,
      const char** names
    )

此方法采用两个参数，如下所示

无.

此方法检索索引中指定位置的列。

const Column* getColumn
    (
      unsigned no
    ) const

列的序数位置编号 no，作为无符号整数。使用 getNoOfColumns() 方法确定索引包含多少列—有关详细信息，请参阅 Index::getNoOfColumns()。

索引中位置为 no 的列，作为指向 Column 实例的指针。请参阅 第 2.3.1 节 “Column 类”。

使用此方法确定是否已为索引启用记录到磁盘。

未记录的索引在集群启动或重新启动时重建。

有序索引当前不支持记录到磁盘；每次启动集群时都会重建它们。（这包括重新启动。）

bool getLogging
    (
      void
    ) const

无.

布尔值

此方法用于获取索引的名称。

const char* getName
    (
      void
    ) const

无.

索引的名称，作为常量字符指针。

此方法用于获取构成索引的列数。

unsigned getNoOfColumns
    (
      void
    ) const

无.

表示索引中列数的无符号整数。

此方法获取索引的对象状态。

virtual Object::Status getObjectStatus
    (
      void
    ) const

无.

Status 值；有关更多信息，请参阅 Object::Status。

此方法获取索引的对象版本（请参阅 NDB 模式对象版本）。

virtual int getObjectVersion
    (
      void
    ) const

无.

索引的对象版本，作为整数。

此方法用于获取索引的对象 ID。

virtual int getObjectId
    (
      void
    ) const

无.

对象 ID，作为整数。

此方法可用于获取索引所属表的名称。

const char* getTable
    (
      void
    ) const

无.

表的名称，作为常量字符指针。

此方法可用于查找索引的类型。

Type getType
    (
      void
    ) const

无.

索引类型。有关可能的值，请参阅 Index::Type。

此方法用于启用或禁用索引到磁盘的日志记录。

void setLogging
    (
      bool enable
    )

setLogging() 接收一个布尔参数 enable。如果 enable 为 true，则为索引启用日志记录；如果为 false，则禁用此索引的日志记录。

无.

此方法设置索引的名称。

这是唯一一个其结果对 MySQL 服务器可见的 Index::set*() 方法。

void setName
    (
      const char* name
    )

索引的所需 name，作为常量字符指针。

无.

此方法设置要建立索引的表。表通过名称引用。

void setTable
    (
      const char* name
    )

要建立索引的表的 name，作为常量字符指针。

无.

此方法用于设置索引类型。

void setType
    (
      Type type
    )

索引的 type。有关可能的值，请参见 Index::Type。

无.

这是一个枚举类型，它描述了由给定 Index 实例表示的列索引的类型。

不要将此枚举类型与 Object::Type 或 Column::Type 混淆。

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