NdbDictionary

无

此类表示 NDB Cluster 中的数据库事件。

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

改进的事件 API (NDB 7.4 及更高版本)。  NDB 7.4 引入了一个基于纪元的事件 API，它取代了早期的基于 GCI 的模型。新版本的 API 还简化了错误检测和处理。这些更改在 NDB API 中通过为 Ndb 和 NdbEventOperation 实现了许多新方法，弃用这两个类中的其他一些方法，以及向 TableEvent 添加新的类型值而实现。

一些新方法直接替换或替代已弃用的方法，但并非所有已弃用的方法都映射到新的方法，其中一些是全新的。旧的（已弃用的）方法显示在下表的第 1 列，新的方法显示在第 2 列；与新方法对应的旧方法显示在同一行。

使用新 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 值。

无.

The Event 构造函数使用给定的名称创建一个新实例，并可选择将其与一个表关联。

请注意，NDB API 不会跟踪分配的事件对象，这意味着用户必须在不再使用 Event 后显式地删除它。

可以使用两种方法调用此方法，第一种方法仅使用名称，如下所示

Event
    (
      const char* name
    )

或者，可以使用事件名称和关联的表，如下所示

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

至少需要一个事件的 name（作为常量字符指针）。可选地，事件还可以与一个表关联；当存在此参数时，它是一个指向 Table 对象的引用（请参阅 第 2.3.27 节，“表类”）。

一个新的 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 节，“表类”。）

此方法用于检查是否将检测到给定的表事件。

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
    )

一个布尔 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
    )

要赋予事件的 name（作为常量字符指针）。

无.

此方法定义要检测事件的表。

默认情况下，事件检测在表中的所有列上进行。使用 addEventColumn() 覆盖此行为。有关详细信息，请参阅 Event::addEventColumn()。

void setTable
    (
      const NdbDictionary::Table& table
    )

您还可以使用此方法中的指针，如下所示

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

当这样使用时，此版本的 setTable() 将在表指针为 NULL 时返回 -1。

此方法需要一个参数，即要检测事件的表的引用或指针（请参阅 第 2.3.27 节，“表类”）。

如果使用了空表指针，则为 -1，否则为 null。

TableEvent 用于对可能与 NDB API 中的表关联的事件类型进行分类。

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

TE_EMPTY、TE_INCONSISTENT 和 TE_OUT_OF_MEMORY 在 NDB 7.4 中添加。