NdbDictionary

無

此類別代表 NDB Cluster 中的資料庫事件。

下表列出 Event 類別的公用方法，以及每個方法的用途或用法

改良事件 API (NDB 7.4 及更新版本)。  NDB 7.4 引入以 epoch 為基礎的事件 API，取代先前的以 GCI 為基礎的模型。新版本的 API 也簡化了錯誤偵測與處理。這些變更藉由為 Ndb 和 NdbEventOperation 實作一些新方法、棄用這兩個類別的數個其他方法，以及將新的類型值新增至 TableEvent 來實作在 NDB API 中。

某些新方法直接取代或替代已棄用的方法，但並非所有已棄用的方法都會對應至新的方法，其中有些是完全新的。舊 (已棄用) 方法顯示在下表的第一欄中，而新方法則顯示在第二欄中；對應至新方法的舊方法顯示在同一列中。

使用新 API 的錯誤處理，藉由檢查從 getEventType2() 傳回的值來完成，而且不再使用方法 hasError() 和 clearError() 來處理，這些方法現在已棄用，而且可能會在 NDB Cluster 的未來版本中移除。為了支援此變更，TableEvent 類型的可能範圍已由此處列出的類型擴充

這些變更的結果是，在 NDB 7.4 及更新版本中，您可以在檢查資料表事件的類型時檢查錯誤，如此處所示

NdbDictionary::Event::TableEvent* error_type = 0;
NdbEventOperation* pOp = nextEvent2();

if (pOp->isErrorEpoch(error_type)
{
  switch (error_type)
  {
    case TE_INCONSISTENT :
      // Handle error/inconsistent epoch...
      break;

    case TE_OUT_OF_MEMORY :
      // Handle error/inconsistent data...
      break;

    //  ...
  }
}

如需更多資訊，請參閱先前表格中顯示的 Ndb 和 NdbEventOperation 方法的詳細說明，以及 Event::TableEvent。

這些是 Event 類別的公用類型

此方法用於新增應該偵測事件的資料行。資料行可以使用其 ID 或名稱來表示。

您必須先叫用 Dictionary::createEvent()，才會偵測到任何錯誤。請參閱 Dictionary::createEvent()。

如果您知道數個欄位的名稱，可以使用 addEventColumns() 一次啟用它們全部的事件偵測。請參閱 Event::addEventColumns()。

此方法可以使用下列任一方式調用

此方法接受單一引數，可以是下列其中之一

無.

此方法用於同時在數個欄位上啟用事件偵測。您必須使用欄位的名稱。

與 addEventColumn() 一樣，您必須先調用 Dictionary::createEvent()，任何錯誤才會被偵測到。請參閱 Dictionary::createEvent()。

void addEventColumns
    (
      int          n,
      const char** columnNames
    )

此方法需要此處列出的兩個引數

無.

此方法用於新增應該偵測到的事件類型。

void addTableEvent
    (
      const TableEvent te
    )

此方法需要 TableEvent 值。

無.

Event 建構子會建立一個具有指定名稱的新實例，並且可以選擇性地與資料表相關聯。

您應該記住，NDB API 不會追蹤已配置的事件物件，這表示使用者必須在不再使用 Event 後明確刪除它。

可以使用兩種方式調用此方法，第一種方式僅按名稱調用，如下所示

Event
    (
      const char* name
    )

或者，您可以使用事件名稱和相關聯的資料表，如下所示

Event
    (
      const char*                  name,
      const NdbDictionary::Table& table
    )

至少需要事件的名稱 (以常數字元指標表示)。您可以選擇性地將事件與資料表相關聯；此引數 (如果存在) 是對 Table 物件的參考 (請參閱 第 2.3.27 節，「Table 類別」)。

Event 的新實例。

此類型的值用於描述事件的生命週期或持久性以及其範圍。

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

此類型的值用於指定資料表事件的報告選項。

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

此方法會取得事件的生命週期和範圍 (也就是其 EventDurability)。

EventDurability getDurability
    (
      void
    ) const

無.

EventDurability 值。

此方法用於從已定義事件的欄位中取得特定的欄位。

const Column* getEventColumn
    (
      unsigned no
    ) const

欄位的編號 (no)，如使用 getNoOfColumns() 所取得 (請參閱 Event::getNoOfEventColumns())。

指向對應於 no 的 Column 的指標。

此方法會取得事件的名稱。

const char* getName
    (
      void
    ) const

無.

事件的名稱，以字元指標表示。

此方法會取得已定義事件的欄位數量。

int getNoOfEventColumns
    (
      void
    ) const

無.

欄位的數量 (以整數表示)，若發生錯誤則為 -1。

此方法會取得事件的物件狀態。

virtual Object::Status getObjectStatus
    (
      void
    ) const

無.

事件的物件狀態。如需可能的值，請參閱 Object::Status。

此方法會取得事件的物件版本 (請參閱 NDB 結構描述物件版本)。

virtual int getObjectVersion
    (
      void
    ) const

無.

事件的物件版本，以整數表示。

此方法會擷取事件的物件 ID。

virtual int getObjectId
    (
      void
    ) const

無.

事件的物件 ID，以整數表示。

此方法用於取得此事件所生效的報告選項。

EventReport getReport
    (
      void
    ) const

無.

Event::EventReport 中指定的報告選項之一。

此方法用於尋找與事件相關聯的資料表。它會傳回對應 Table 物件的參考。您也可以使用 getTableName() 直接取得資料表的名稱。

const NdbDictionary::Table* getTable
    (
      void
    ) const

無.

與事件相關聯的資料表 (如果有的話)，以指向 Table 物件的指標表示；否則，此方法會傳回 NULL。(請參閱 第 2.3.27 節，「Table 類別」。)

此方法用於檢查是否會偵測到指定的資料表事件。

bool getTableEvent
    (
      const TableEvent te
    ) const

此方法接受單一參數，即資料表事件的類型，也就是 TableEvent 值。

如果將偵測到 TableEvent 類型 te 的事件，則此方法會傳回 true。否則，回傳值為 false。

此方法會取得與事件相關聯的資料表的名稱，並且可以作為 getTable() 的便利替代方案。(請參閱 Event::getTable()。)

const char* getTableName
    (
      void
    ) const

無.

與此事件相關聯的資料表名稱，以字元指標表示。

此方法用於設定 合併事件旗標，預設值為 false。將其設定為 true 表示將合併事件，如下所示

void mergeEvents
    (
      bool flag
    )

布林值 旗標。

無.

此方法會設定事件的持久性，也就是其生命週期和範圍。

void setDurability(EventDurability ed)

此方法需要單一 EventDurability 值作為參數。

無.

此方法用於設定事件的報告選項。可能的選項值可在 Event::EventReport 中找到。

您必須使用 EventReport 值 ER_DDL (在相同的 NDB Cluster 版本中新增) 來呼叫 setReport()。

例如，若要在名為 myEvent 的 Event 物件上啟用 DDL 事件報告，您必須呼叫此方法，如下所示

myEvent.setReport(NdbDictionary::Event::ER_DDL);

void setReport
    (
      EventReport er
    )

EventReport 選項值。

無.

此方法用於設定事件的名稱。在目前應用程式中可見的所有事件中，名稱必須是唯一的 (請參閱 Event::getDurability())。

您也可以在第一次建立事件時設定事件的名稱。請參閱 Event 建構子。

void setName
    (
      const char* name
    )

要提供給事件的名稱 (以常數字元指標表示)。

無.

此方法會定義要在其上偵測事件的資料表。

預設情況下，事件偵測會發生在表格中的所有欄位。使用 addEventColumn() 來覆寫此行為。詳細資訊請參閱 Event::addEventColumn()。

void setTable
    (
      const NdbDictionary::Table& table
    )

您也可以在此方法中使用指標，如下所示

void setTable
    (
      const NdbDictionary::Table*; table
    )

當這樣使用時，如果表格指標為 NULL，此版本的 setTable() 會回傳 -1。

此方法需要一個單一參數，即表格的參考或指標（請參閱 章節 2.3.27，「表格類別」），要在其上偵測事件。

如果使用空表格指標，則回傳 -1，否則回傳 null。

TableEvent 用於分類 NDB API 中可能與表格相關聯的事件類型。

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

TE_EMPTY、TE_INCONSISTENT 和 TE_OUT_OF_MEMORY 是在 NDB 7.4 中新增的。