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 Schema 物件版本）。

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 混淆。

下表顯示可能的值，以及描述