NdbOperation

NdbIndexScanOperation

NdbScanOperation 类表示事务中使用的扫描操作。此类继承自 NdbOperation。

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

此类没有公共构造函数。要创建 NdbScanOperation 的实例，必须使用 NdbTransaction::getNdbScanOperation() 方法。

此类定义了两种公共类型，如下所示

调用此方法将关闭扫描。使用此方法关闭扫描后，此扫描返回的行将不再可用。

有关多个线程尝试使用独占锁执行相同扫描以及这如何影响关闭扫描的信息，请参见 具有独占锁的扫描。

void close
    (
      bool forceSend = false,
      bool releaseOp = false
    )

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

无.

此方法用于删除当前元组。

const NdbOperation* deleteCurrentTuple
    (
      NdbTransaction* takeOverTrans,
      const NdbRecord* record,
      char* row = 0,
      const unsigned char* mask = 0,
      const NdbOperation::OperationOptions* opts = 0,
      Uint32 sizeOfOpts = 0
    )

有关更多信息，请参见 第 2.3.22 节 “NdbRecord 接口”。

与 NdbRecord 接口一起使用时，此方法采用此处列出的参数

成功返回 0，失败返回 -1。

获取此扫描的 NdbTransaction 对象。

NdbTransaction* getNdbTransaction
    (
      void
    ) const

无.

指向 NdbTransaction 对象的指针。

此方法用于确定给定的扫描操作是否已修剪到单个分区。对于使用 NdbRecord 定义的扫描，可以在执行扫描之前或之后调用此方法。对于未使用 NdbRecord 定义的扫描，getPruned() 仅在执行扫描后才有效。

bool getPruned
    (
      void
    ) const

无.

如果扫描被修剪到单个表分区，则返回 true。

此方法锁定当前元组。

可以使用可选的单个参数调用此方法，可以使用以下两种方法之一

NdbOperation* lockCurrentTuple
    (
      void
    )

NdbOperation* lockCurrentTuple
    (
      NdbTransaction* lockTrans
    )

使用 NdbRecord 时，也支持此方法的以下签名

NdbOperation *lockCurrentTuple
    (
      NdbTransaction* takeOverTrans,
      const NdbRecord* record,
      char* row = 0,
      const unsigned char* mask = 0
    )

此方法还支持指定一个或多个 OperationOptions（在使用 NdbRecord 时也是如此）

NdbOperation *lockCurrentTuple
    (
      NdbTransaction* takeOverTrans,
      const NdbRecord* record,
      char* row = 0,
      const unsigned char* mask = 0,
      const NdbOperation::OperationOptions* opts = 0,
      Uint32 sizeOfOptions = 0
    )

此方法采用一个可选参数 - 应执行锁定的交易。如果省略，则交易为当前交易。

使用 NdbRecord 接口时，此方法采用以下参数，如下列表所示

在 NdbRecAttr 样式扫描上调用 NdbRecord 扫描锁接管是无效的，在 NdbRecord 样式扫描上调用 NdbRecAttr 样式扫描锁接管也是无效的。

此方法返回指向 NdbOperation 对象的指针，或者返回 NULL。

此方法用于获取扫描交易中的下一个元组。每次调用 nextResult() 后，NdbOperation::getValue() 中定义的缓冲区和 NdbRecAttr 对象将使用扫描元组中的值进行更新。

当在文件末尾执行 nextResult() 时，NDB 返回错误代码 4210（Ndb 发送的信息超过指定长度），并且通过将额外的交易对象返回到正确的 TC 节点的空闲列表来释放它。

可以使用以下两种方法之一调用此方法。第一个如下所示

int nextResult
    (
      bool fetchAllowed = true,
      bool forceSend = false
    )

也可以如下所示使用此方法

int nextResult
    (
      const char*& outRow,
      bool fetchAllowed = true,
      bool forceSend = false
    )

此方法采用以下两个参数

也可以使用以下三个参数调用此方法

此方法返回以下 4 个整数值之一，解释如下列表所示

请参见 第 2.5.5 节“NDB API 基本扫描示例”。

此方法用于执行扫描。

virtual int readTuples
    (
      LockMode mode = LM_Read,
      Uint32   flags = 0,
      Uint32   parallel = 0,
      Uint32   batch = 0
    )

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

成功返回 0，失败返回 -1。

使用此方法可以在不更改任何 getValue() 调用或搜索条件的情况下重新启动扫描。

int restart
    (
      bool forceSend = false
    )

通过将 forceSend 设置为 true 来调用此方法，以强制发送交易。

成功返回 0；失败返回 -1。

此类型的取值是与 readTuples() 方法一起使用的扫描标志。可以使用多个值，在这种情况下，它们作为该方法的第二个参数通过 OR 进行组合。有关更多信息，请参见 NdbScanOperation::readTuples()。

下表显示了可能的值及其说明

NdbScanOperation

此数据结构用于将选项传递给 NdbRecord 的 scanTable() 和 scanIndex() 方法（NdbTransaction 类）。通过设置 optionsPresent 字段中的相应位来标记每个选项类型的存在。只有 optionsPresent 字段中标记的选项类型需要合理的数据。

所有数据在操作定义时从 ScanOptions 结构（以及任何子结构）中复制出来。如果不需要任何选项，则可以将 NULL 作为 ScanOptions 指针传递。

下表显示了构成此结构的元素

有关更多信息，请参见 第 2.3.22 节 “NdbRecord 接口”。

此方法用于更新当前元组。

最初，可以使用单个可选参数调用此方法，如下所示

NdbOperation* updateCurrentTuple
    (
      void
    )


NdbOperation* updateCurrentTuple
    (
      NdbTransaction* updateTrans
    )

在使用 NdbRecord 进行扫描时，也可以使用此方法，如下所示

NdbOperation* updateCurrentTuple
    (
      NdbTransaction*      takeOverTrans,
      const NdbRecord*     record,
      const char*          row,
      const unsigned char* mask = 0
    )

有关详细信息，请参阅 第 2.3.22 节 “NdbRecord 接口”。

此方法采用一个可选参数 - 应执行锁定的交易。如果省略，则交易为当前交易。

使用 NdbRecord 接口时，此方法采用以下参数，如下所述

此方法返回一个 NdbOperation 对象或 NULL。