没有任何

没有任何

任何重要的 NDB API 程序都至少使用一个Ndb. 通过使用多个 Ndb对象，可以实现多线程应用程序。您应该记住，一个 Ndb对象不能在线程之间共享；但是，单个线程可以使用多个Ndb对象。单个应用程序进程最多可以支持 4711 个 Ndb对象。

下表列出了该类的公共方法以及每个方法的用途或用途：

该类Ndb没有定义任何公共类型，但确实定义了三个数据结构，如下所列：

这将创建一个实例 Ndb，它表示与 NDB Cluster 的连接。所有 NDB API 应用程序都应该从至少一个 Ndb对象的创建开始。这需要创建至少一个 实例 Ndb_cluster_connection，用作集群连接字符串的容器。

Ndb
    (
      Ndb_cluster_connection* ndb_cluster_connection,
      const char*                    catalogName = "",
      const char*                    schemaName = "def"
    )

类Ndb构造函数最多可以接受 3 个参数，其中只有第一个是必需的：

一个Ndb对象。

Ndb 应该调用该类 的析构函数以终止Ndb. 它不需要参数，也不需要任何特殊处理。

这是为关闭事务提供的两个 NDB API 方法之一（另一个是 NdbTransaction::close()）。一旦交易完成，您必须调用这两种方法之一来关闭交易，无论交易是否成功。

如果事务尚未提交，调用此方法时将中止事务。请参阅 Ndb::startTransaction()。

void closeTransaction
    (
      NdbTransaction *transaction
    )

此方法采用单个参数，即指向 NdbTransaction要关闭的 的指针。

无（void）。

给定表及其键，此方法可用于计算分布哈希值。

computeHash()只能用于使用本机NDB 分区的表。

static int computeHash
    (
      Uint32*                     hashvalueptr,
      const NdbDictionary::Table* table,
      const struct Key_part_ptr*  keyData,
      void*                       xfrmbuf = 0,
      Uint32                      xfrmbuflen = 0
    )

此方法采用以下参数：

成功时为 0，失败时为错误代码。如果方法调用成功，计算的哈希值将通过 提供 hashvalueptr。

此方法创建对数据库事件的订阅。

使用ndb_restore 恢复 NDB Cluster 后，NDB API 事件订阅不会持续存在 ；在这种情况下，必须明确地重新创建所有订阅。

NdbEventOperation* createEventOperation
    (
      const char *eventName
    )

此方法采用单个参数，唯一 eventName标识您希望订阅的事件。

指向 NdbEventOperation对象的指针（或NULL，在失败的情况下）。请参阅 第 2.3.16 节，“NdbEventOperation 类”。

NdbEventOperation此方法删除对由对象 表示的数据库事件的订阅 。

在完全读取事件缓冲区之前，不会释放已删除的事件操作使用的内存。这意味着在这种情况下，您必须继续调用 pollEvents()和 nextEvent()直到这些方法分别返回0和 NULL，以便释放此内存。

int dropEventOperation
    (
      NdbEventOperation *eventOp
    )

此方法需要一个输入参数，一个指向 的实例的指针 NdbEventOperation。

0成功；任何其他结果均表示失败。

Ndb

NDB 7.4 中添加了此结构，用于处理事件缓冲区内存使用统计信息。它用作 的参数 Ndb::get_event_buffer_memory_usage()。

EventBufferMemoryUsage具有下表所示的属性：

此方法用于获取用于检索或操作数据库架构信息的对象。该 Dictionary对象包含有关集群中所有表的元信息。

此方法返回的字典独立于任何事务运行。有关更多信息，请参见 第 2.3.3 节，“字典类”。

NdbDictionary::Dictionary* getDictionary
    (
      void
    ) const

没有。

类的一个实例 Dictionary。

该方法可用于获取当前数据库的名称。

const char* getDatabaseName
    (
      void
    )

没有任何。

当前数据库的名称。

此方法可用于获取当前数据库模式名称。

const char* getDatabaseSchemaName
    (
      void
    )

没有。

当前数据库模式的名称。

迭代属于当前 GCI 的不同事件操作，在调用 nextEvent(). 在处理事件数据之前，您可以使用此方法获取纪元的摘要信息（例如所有表的列表）。

此方法在 NDB 7.4 中已弃用，并且可能会在未来的版本中删除。在 NDB 7.4 及更高版本中，您应该 getNextEventOpInEpoch2() 改为使用。

const NdbEventOperation* getGCIEventOperations
    (
      Uint32* iter,
      Uint32* event_types
    )

迭代器和事件类型掩码。设置 开始。 *iter=0

下一个事件操作；NULL 当没有更多的事件操作时返回。如果 event_types不是 NULL，则在调用方法后它包含接收到的事件类型的位掩码。.

获取可用于事件缓冲区的最大内存（以字节为单位）。这与读取 ndb_eventbuffer_max_alloc MySQL Server中系统变量的值是一样的。

此方法是在 NDB 7.3.3 中添加的。

unsigned get_eventbuf_max_alloc
    (
      void
    )

没有。

事件缓冲区可用的最大内存，以字节为单位。

获取 — 即，一旦 达到ndb_eventbuffer_free_percent，在缓冲恢复之前应该可用的事件缓冲区内存的百分比 。ndb_eventbuffer_max_alloc该值的计算方式为 used * 100 / ndb_eventbuffer_max_alloc，其中used是实际使用的事件缓冲区内存量，以字节为单位。

NDB 7.4 中添加了此方法。

unsigned get_eventbuffer_free_percent
    (
      void
    )

pct必须存在的事件缓冲区内存 的百分比 ( )。有效范围是 1 到 99（含）。

没有。

获取事件缓冲区使用率的百分比 ndb_eventbuffer_max_alloc。与 不同 ，此方法以 数据结构 get_eventbuffer_free_percent()的形式提供完整的使用信息 。EventBufferMemoryUsage

NDB 7.4 中添加了此方法。

void get_event_buffer_memory_usage
    (
      EventBufferMemoryUsage&
    )

EventBufferMemoryUsage 对接收使用数据 的结构的引用 。

没有。

在 NDB 7.4 中添加，此方法取代 getLatestGCI()了现在已弃用并在未来的 NDB Cluster 版本中删除的方法。

在 NDB 7.4.7 之前，此方法返回事件队列中的最高纪元号。在 NDB 7.4.7 及更高版本中，它返回调用后找到的最高纪元编号 pollEvents2()（错误号 20700220）。

Uint64 getHighestQueuedEpoch
    (
      void
    )

没有。

最近的纪元号，一个整数。

获取最近的全局检查点的索引。

此方法在 NDB 7.4 中已弃用，并且可能会在未来的版本中删除。在 NDB 7.4 及更高版本中，您应该 getHighestQueuedEpoch() 改为使用。

Uint64 getLatestGCI
    (
      void
    )

没有。

最近的 GCI，一个整数。

此方法为您提供了两种不同的方法来获取NdbError表示错误情况的对象。有关 NDB API 中错误处理的更多详细信息，请参阅 NDB Cluster API 错误。

该getNdbError()方法实际上有两个变体。

其中第一个只是获取最近发生的错误：

const NdbError& getNdbError
    (
      void
    )

第二个变体返回与给定错误代码对应的错误：

const NdbError& getNdbError
    (
      int errorCode
    )

无论使用哪个版本的方法， NdbError返回的对象都会一直存在，直到调用下一个 NDB API 方法。

要获取最近的错误，只需调用 getNdbError()而不带任何参数。要获取与特定 匹配的错误 errorCode，请调用将代码 (an int) 作为参数传递给它的方法。有关 NDB API 错误代码和相应错误消息的列表，请参阅 第 2.4 节，“NDB API 错误和错误处理”。

NdbError包含有关错误信息 的对象，包括错误类型以及有关错误如何产生的上下文信息（如果适用）。有关详细信息，请参阅第 2.3.15 节，“NdbError 结构”。

此方法提供了一种简单且安全的方法来访问有关错误的任何额外信息。而不是从 NdbError对象的 details属性中读取这些额外的详细信息（现在已弃用，取而代之的是getNdbErrorDetail()‐参见 Bug #48851）。此方法可以将此类详细信息存储在用户提供的缓冲区中，并返回指向此缓冲区开头的指针。如果包含详细信息的字符串超过缓冲区的长度，则会将其截断以适合。

getErrorDetail()以字符串形式提供错误来源。在违反唯一约束的情况下（错误 893），此字符串提供问题来源索引的完全限定名称，格式为 database-name// schema-name/ table-name, index-name(NdbError.details另一方面，仅提供索引 ID，并且它通常不容易看出该索引属于哪个表。）无论错误类型和有关此错误的详细信息如何，检索到的字符串getErrorDetail()始终以 null 结尾。

该getNdbErrorDetail()方法具有以下签名：

const char* getNdbErrorDetail
            (
              const NdbError& error,
              char*           buffer,
              Uint32          bufferLength
            ) const

要获取有关错误的详细信息，请 getNdbErrorDetail()使用对相应NdbError 对象的引用 abuffer和此缓冲区的长度（表示为无符号 32 位整数）进行调用。

当有关的额外详细信息 error可用时，此方法返回指向所 buffer提供的开头的指针。如前所述，如果包含详细信息的字符串长于bufferLength，则该字符串将被截断以适合。如果没有可用的附加详细信息，则getNdbErrorDetail()返回 NULL。

如果在Ndb初始化之前为对象设置了名称，则可以使用此方法检索它。用于调试。

此方法是在 NDB 7.3.6 中添加的。（漏洞 #18419907）

const char* getNdbObjectName
    (
      void
    ) const

没有。

Ndb对象名称，如果已 使用setNdbObjectName(). 否则，此方法返回 0。

迭代构成当前全局检查点的单个事件操作。在处理事件数据之前，使用 following nextEvent2()获取 epoch 的摘要信息，例如所有表的列表。

异常时期没有任何与之关联的事件操作。

const NdbEventOperation* getNextEventOpInEpoch2
    (
      Uint32* iter,
      Uint32* event_types
    )

初始设置iter为0；这是 NULL这个时期内没有更多事件的时候。如果 event_types不是 NULL，它保存接收到的事件类型的位掩码。

指向 next 的指针 NdbEventOperation（如果有的话）。

迭代构成当前全局检查点的单个事件操作。在处理事件数据之前，使用 following nextEvent2()获取 epoch 的摘要信息，例如所有表的列表。与此相同， getNextEventOpInEpoch3() 但添加了第三个参数，该参数保存所有接收到的 AnyValues 的合并，显示为给定表上的所有操作设置了哪些位。

异常时期没有任何与之关联的事件操作。

在 NDB 7.3.20、7.4.18 和 7.5.9 中添加了此方法。（漏洞 #26333981）

const NdbEventOperation* getNextEventOpInEpoch2
    (
      Uint32* iter,
      Uint32* event_types
      Uint32* cumulative_any_value
    )

初始设置iter为0；这是 NULL这个时期内没有更多事件的时候。如果 event_types不是 NULL，它保存接收到的事件类型的位掩码。如果 cumulative_any_value不是 NULL，则它保存所有收到的 AnyValues 的合并。

指向 next 的指针 NdbEventOperation（如果有的话）。

此方法可用于获取对给定 Ndb对象的引用。这与 的输出中对应于此对象的给定操作返回的值相同 DUMP 2350。

Uint32 getReference
    (
      void
    )

没有。

一个 32 位无符号整数。

此方法用于初始化 Ndb对象。

int init
    (
      int maxNoOfTransactions = 4
    )

该init()方法采用整数类型的单个参数maxNoOfTransactions。NdbTransaction 此参数指定此实例可以处理 的最大并行对象数Ndb。的最大允许值为maxNoOfTransactions1024；如果未指定，则默认为 4。

每个扫描或索引操作都使用一个额外的 NdbTransaction对象。

此方法返回一个int，它可以是以下两个值之一：

检查所有事件是否一致。如果在资源耗尽时发生节点故障，则事件可能会丢失，因此传递的事件数据可能会不完整。此方法可以确定是否属于这种情况。

此方法在 NDB 7.4 中已弃用，并且可能会在未来的版本中删除。在 NDB 7.4 及更高版本中，您应该改为使用 NdbEventOperation::getEventType2() 来确定事件的类型 - 在这种情况下，事件是否为 类型 TE_INCONSISTENT。请参阅 事件::表事件。

bool isConsistent
    (
      Uint64& gci
    )

对全局检查点索引的引用。如果有的话，这是发现的第一个不一致的 GCI。

true如果所有事件都一致。

如果在资源耗尽时发生节点故障，则事件可能会丢失，因此传递的事件数据可能会不完整。此方法可以通过检查给定 GCI 中的所有事件是否一致来确定是否属于这种情况。

此方法在 NDB 7.4 中已弃用，并且可能会在未来的版本中删除。在 NDB 7.4 及更高版本中，您应该改为使用 NdbEventOperation::getEventType2() 来确定事件的类型 - 在这种情况下，事件是否为 类型 TE_INCONSISTENT。请参阅 事件::表事件。

bool isConsistentGCI
    (
      Uint64 gci
    )

全局检查点索引。

true如果这个 GCI 是一致的； false表示 GCI 可能不一致。

检查上次调用是否已看到更高队列的纪元 Ndb::pollEvents2()，或者是否找到了TE_CLUSTER_FAILURE事件。

在检测到集群故障后，返回的最高排队纪元 pollEvents2()可能不再增加。在这种情况下，与其轮询更多事件，不如使用事件 nextEvent()直到检测到TE_CLUSTER_FAILURE被检测到，然后在集群再次可用时重新连接到集群。

NDB 7.3.10 和 7.4.7 中添加了此方法（缺陷 #18753887）。

bool isExpectingHigherQueuedEpochs
      (
        void
      )

没有。

如果最后一次调用看到排队的纪元， pollEvents2()或者在集群失败的情况下，则为真。

Ndb

Key_part_ptr通过传递指向分布键值的指针，提供了一种在开始交易和计算哈希值时定义键部分数据的便捷方法。当分配键有多个部分时，它们应该作为数组传递，最后一部分的指针设置为 NULL。有关如何使用此结构的更多信息， 请参阅 Ndb::startTransaction()和 Ndb::computeHash() 。

AKey_part_ptr具有下表所示的属性：

返回具有来自订阅队列的数据的下一个事件操作。

从 NDB 7.3.6 开始，此方法在处理它们时从事件队列中清除不一致的数据事件。为了能够清除这些和更高版本中的所有此类事件，应用程序必须调用此方法，即使在pollEvents()已经返回 0 的情况下也是如此。（错误 #18716991）

此方法在 NDB 7.4 中已弃用，并且可能会在未来的版本中删除。在 NDB 7.4 及更高版本中，您应该nextEvent2() 改为使用。

NdbEventOperation* nextEvent
    (
      void
    )

没有任何。

NdbEventOperation如果存在这样的事件， 此方法将返回表示订阅队列中下一个事件的 对象。如果队列中没有事件，则返回NULL。

返回与从事件队列中出队的数据关联的事件操作。这应该在 pollEvents2()填充队列后重复调用，直到事件队列为空。

在 NDB 7.4 中添加，此方法取代 nextEvent()了现在已弃用并在未来的 NDB Cluster 版本中删除的方法。

调用此方法后，使用 NdbEventOperation::getEpoch() 判断纪元，然后使用检查返回事件数据的类型 NdbEventOperation::getEventType2()。必须为所有异常 TableEvent类型提供处理，包括TE_EMPTY、 TE_INCONSISTENT和 TE_OUT_OF_MEMORY（也在 NDB 7.4 中引入）。除了这里提到的两个方法之外，没有其他 NdbEventOperation方法应该被称为一个特殊的时代。TE_EMPTY当数据节点空闲时，返回空 epochs ( ) 可能会淹没应用程序。如果这是不可取的，应用程序应该过滤掉任何空的时期。

NdbEventOperation* nextEvent2
    (
      void
    )

没有任何。

如果存在这样的事件，此方法将返回 NdbEventOperation表示事件队列中下一个事件的对象。如果队列中没有事件，则返回 NULL。

Ndb

APartitionSpec用于使用以下任一条件描述表分区：

APartitionSpec有两个属性，a SpecType和aSpec 是that对应的数据结构 SpecType，如下表所示：

此方法等待 GCP 完成。它用于确定订阅队列中是否有任何事件可用。

此方法等待下一个纪元，而不是下一个 GCP。有关更多信息，请参阅 第 2.3.16 节，“NdbEventOperation 类”。

在 NDB 7.4 中，此方法已弃用，并会在未来的 NDB Cluster 版本中删除；改用 pollEvents2()。

在 NDB 7.4.7 之前，与之前在 NDB 7.4 中添加pollEvents()的异常类型不兼容 TableEvent（错误#20646496）；在 NDB 7.4.7 及更高版本中，pollEvents()与这些事件类型兼容，如本节后面所述。

int pollEvents
    (
      int     maxTimeToWait,
      Uint64* latestGCI = 0
    )

此方法采用此处列出的两个参数：

pollEvents()返回 type 的值 int，可以解释如下：

在 NDB 7.4.7 及更高版本中，当pollEvents() 在事件队列的头部发现异常事件时，该方法返回 1，否则行为如下：

等待事件发生。任何事件数据可用时立即返回。此方法还将一个纪元的完整事件数据移动到事件队列中。

在 NDB 7.4 中添加，此方法取代 pollEvents()了现在已弃用并在未来的 NDB Cluster 版本中删除的方法。

int pollEvents2
    (
      int aMillisecondNumber,
      Uint64* highestQueuedEpoch = 0
    )

此方法采用此处列出的两个参数：

pollEvents2()返回一个整数，其值可以解释如下：

该方法用于设置当前数据库的名称。

void setDatabaseName
    (
      const char *databaseName
    )

setDatabaseName()接受一个必需的参数，即要设置为当前数据库的新数据库的名称。

没有。

此方法设置当前数据库模式的名称。

void setDatabaseSchemaName
    (
      const char *databaseSchemaName
    )

数据库模式的名称。

没有。

默认情况下禁用空时期的排队。此方法可用于启用此类排队，在这种情况下，在方法调用之后进入事件缓冲区的任何新的空时期都会排队。

当启用空纪元排队时， nextEvent()将一个空纪元关联到一个且只有一个连接到订阅 Ndb对象的订阅（事件操作）。这意味着每个订阅不能有超过一个空时期，即使用户可能有许多订阅与同一Ndb对象相关联。

setEventBufferQueueEmptyEpoch()没有关联的 getter 方法。这是有意为之的，因为这个 setter 适用于排队 新纪元，而队列本身可能仍然反映在调用 setter 之前存在的事态。因此，在过渡期间，即使关闭排队，也可能会在队列中发现空时期。

setEventBufferQueueEmptyEpoch()在 NDB 7.4.11 中添加。

void setEventBufferQueueEmptyEpoch
  (
    bool queue_empty_epoch
  )

此方法采用单个输入参数，一个布尔值。调用方法 withtrue启用空事件排队；传递false给该方法会禁用此类排队。

没有。

设置可用于事件缓冲区的最大内存（以字节为单位）。ndb_eventbuffer_max_alloc 这与在 MySQL 服务器中 设置系统变量的值具有相同的效果 。

此方法是在 NDB 7.3.3 中添加的。

void set_eventbuf_max_alloc
    (
      unsigned size
    )

size事件缓冲区 所需的最大值，以字节为单位。

没有。

集 ndb_eventbuffer_free_percent——也就是说，一旦 ndb_eventbuffer_max_alloc 达到，在缓冲恢复之前应该可用的事件缓冲内存的百分比。

NDB 7.4 中添加了此方法。

int set_eventbuffer_free_percent
    (
      unsigned pct
    )

pct必须存在的事件缓冲区内存 的百分比 ( )。有效范围是 1 到 99（含）。

设置的值。

从 NDB 7.3.6 开始，您可以设置一个任意的、人类可读的名称来标识Ndb 用于调试目的的对象。然后可以使用 检索此名称 getNdbObjectName()。（缺陷 #18419907）这必须在调用 init()此对象之前完成；尝试在初始化失败后设置名称并出现错误。

您只能为给定 Ndb对象设置一次名称；已设置名称后的后续尝试失败并出现错误。

int setNdbObjectName
    (
      const char* name
    )

name旨在供人类阅读的 。

0 成功。

此方法用于开始新事务。共有三种变体，其中最简单的变体使用表和分区键或分区 ID 来指定事务协调器 (TC)。第三种变体使您可以通过指向密钥数据的指针来指定 TC。

事务完成后，必须使用 NdbTransaction::close()或 关闭它Ndb::closeTransaction()。否则将中止交易。无论事务的最终结果如何，都必须执行此操作，即使它由于错误而失败。

有关更多信息，请参阅Ndb::closeTransaction()和 NdbTransaction::close()。

NdbTransaction* startTransaction
    (
      const NdbDictionary::Table* table = 0,
      const char* keyData = 0,
      Uint32* keyLen = 0
    )

该方法采用以下三个参数：

NdbTransaction* startTransaction
    (
      const NdbDictionary::Table* table,
      const struct Key_part_ptr*  keyData,
      void*                       xfrmbuf = 0,
      Uint32                      xfrmbuflen = 0
    )

指定事务协调器时，此方法采用此处列出的四个参数：

成功时，一个 NdbTransaction对象。如果失败，NULL则返回。

假设表的分区键是单列 BIGINT。然后您将声明分布键数组，如下所示：

Key_part_ptr distkey[2];

分发键的值将定义如下所示：

unsigned long long distkeyValue= 23;

指向分发键数组的指针将设置如下：

distkey[0].ptr= (const void*) &distkeyValue;

该指针的长度将相应地设置：

distkey[0].len= sizeof(distkeyValue);

NULL分布键数组必须以一个元素 结尾 。这是必要的，以避免有一个附加参数提供分布键中的列数：

distkey[1].ptr= NULL;
distkey[1].len= NULL;

将缓冲区设置为NULL允许 startTransaction()自动分配和释放内存：

xfrmbuf= NULL;
xfrmbuflen= 0;

现在，当您开始交易时，您可以直接访问包含所需信息的节点。

此方法的另一个分布感知版本使您可以指定表和分区（使用分区 ID）作为选择事务协调器的提示，其定义如下所示：

NdbTransaction* startTransaction
    (
      const NdbDictionary::Table* table,
      Uint32 partitionId
    )

如果集群的数据节点数与其片段副本数相同，则指定事务协调器不会提高性能，因为每个数据节点都包含整个数据库。但是，如果数据节点的数量大于片段副本的数量（例如，在 NoOfReplicas具有四个数据节点的集群中 设置为 2），您应该会看到使用分布感知版本的性能显着提高这种方法。

仍然可以像以前一样使用此方法，而无需指定事务协调器。在任何一种情况下，您仍然必须显式关闭事务，无论调用是否startTransaction()成功。