无

NdbIndexOperation，NdbScanOperation

NdbOperation 表示“通用”数据操作。它的子类表示更具体类型的操作。有关操作类型及其对应 NdbOperation 子类的列表，请参阅 NdbOperation::Type。

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

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

NdbOperation 类定义了三种公共类型，如下表所示

此类型用于确定失败的操作是否应强制中止事务。它用作 execute() 方法的参数，有关更多信息，请参阅 NdbTransaction::execute()。

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

将两个寄存器的内容相加；将结果存储在第三个寄存器中。

int add_reg
    (
      Uint32 RegSource1, 
      Uint32 RegSource2, 
      Uint32 RegDest
    )

成功时返回 0，否则返回 -1。

如果指定的列为 NULL，则分支到解释程序中的标签。

int branch_col_eq_null
    (
      Uint32 ColId, 
      Uint32 Label
    )

成功时返回 0，否则返回 -1。

如果指定的列不为 NULL，则分支到解释程序中的标签。

int branch_col_ne_null
    (
      Uint32 ColId, 
      Uint32 Label
    )

无

如果给定值等于指定列的值，则分支到解释程序中的标签。

int branch_col_eq
    (
      Uint32 ColId, 
      const void* val, 
      Uint32 len,
      bool,
      Uint32 Label
    )

成功时返回 0，否则返回 -1。

如果给定值不等于指定列的值，则分支到解释程序中的标签。

int branch_col_ne
    (
      Uint32 ColId, 
      const void* val, 
      Uint32 len,
      bool,
      Uint32 Label
    )

成功时返回 0，否则返回 -1。

如果给定值小于列值，则分支到解释程序中的标签。

int branch_col_lt
    (
      Uint32 ColId, 
      const void* val, 
      Uint32 len,
      bool,
      Uint32 Label
    )

成功时返回 0，否则返回 -1。

如果给定值小于或等于列值，则分支到解释程序中的标签。

int branch_col_le
    (
      Uint32 ColId, 
      const void* val, 
      Uint32 len,
      bool,
      Uint32 Label
    )

成功时返回 0，否则返回 -1。

如果给定值大于列值，则分支到解释程序中的标签。

int branch_col_gt
    (
      Uint32 ColId, 
      const void* val, 
      Uint32 len,
      bool,
      Uint32 Label
    )

成功时返回 0，否则返回 -1。

如果给定值大于或等于列值，则分支到解释程序中的标签。

int branch_col_ge
    (
      Uint32 ColId, 
      const void* val, 
      Uint32 len,
      bool,
      Uint32 Label
    )

成功时返回 0，否则返回 -1。

如果列值匹配通配符模式，则分支。此方法和 branch_col_notlike() 都支持 MySQL LIKE 运算符使用的通配符：% 表示任何 0 个或多个字符的字符串，_ 表示任何单个字符。

列的类型必须是 CHAR、VARCHAR、BINARY 或 VARBINARY 之一。

int branch_col_like
    (
      Uint32 ColId, 
      const void* val, 
      Uint32 len,
      bool,
      Uint32 Label
    )

成功时返回 0，否则返回 -1。

如果列值与给定的通配符模式不匹配，则分支。此方法和 branch_col_like() 都支持与 MySQL LIKE 运算符相同的通配符 %（0 个或多个字符）和 _（任何一个字符）。

列的类型必须是 CHAR、VARCHAR、BINARY 或 VARBINARY 之一。

int branch_col_notlike
    (
      Uint32 ColId, 
      const void* val, 
      Uint32 len,
      bool,
      Uint32 Label
    )

成功时返回 0，否则返回 -1。

如果列值与位掩码进行逻辑按位 AND 运算的结果等于位掩码，则分支。

另请参阅 按位逻辑比较。

int branch_col_and_mask_eq_mask
    (
      Uint32 ColId, 
      const void* mask, 
      Uint32 len,
      bool,
      Uint32 Label
    )

成功时返回 0，否则返回 -1。

如果逻辑按位 AND 中的列值与位掩码不相等，则分支。

另请参阅 按位逻辑比较。

int branch_col_and_mask_ne_mask
    (
      Uint32 ColId, 
      const void* mask, 
      Uint32 len,
      bool,
      Uint32 Label
    )

成功返回 0，否则返回 -1。

如果逻辑按位 AND 中的列值与位掩码相等且等于 0，则分支。

另请参阅 按位逻辑比较。

int branch_col_and_mask_eq_zero
    (
      Uint32 ColId, 
      const void* mask, 
      Uint32 len,
      bool,
      Uint32 Label
    )

成功时返回 0，否则返回 -1。

如果逻辑按位 AND 中的列值与位掩码不相等且不等于 0，则分支。

另请参阅 按位逻辑比较。

int branch_col_and_mask_ne_zero
    (
      Uint32 ColId, 
      const void* mask, 
      Uint32 len,
      bool,
      Uint32 Label
    )

成功返回 0，否则返回 -1。

在解释程序中定义搜索条件。将右寄存器值与左寄存器值进行比较；如果右值大于等于左值，则分支到标签。

int branch_ge
    (
      Uint32 RegLvalue, 
      Uint32 RegRvalue, 
      Uint32 Label
    )

成功时返回 0，否则返回 -1。

在解释程序中定义搜索条件。将右寄存器值与左寄存器值进行比较；如果右值大于左值，则分支到标签。

int branch_gt
    (
      Uint32 RegLvalue, 
      Uint32 RegRvalue, 
      Uint32 Label
    )

成功时返回 0，否则返回 -1。

在解释程序中定义搜索条件。将右寄存器值与左寄存器值进行比较；如果右值小于左值，则分支到标签。

int branch_le
    (
      Uint32 RegLvalue, 
      Uint32 RegRvalue, 
      Uint32 Label
    )

成功时返回 0，否则返回 -1。

在解释程序中定义搜索条件。将右寄存器值与左寄存器值进行比较；如果右值小于等于左值，则分支到标签。

int branch_lt
    (
      Uint32 RegLvalue, 
      Uint32 RegRvalue, 
      Uint32 Label
    )

成功时返回 0，否则返回 -1。

当两个寄存器值相等时，分支到解释程序中的标签。

int branch_eq
    (
      Uint32 RegLvalue, 
      Uint32 RegRvalue, 
      Uint32 Label
    )

成功时返回 0，否则返回 -1。

当两个寄存器值不相等时，分支到解释程序中的标签。

int branch_eq
    (
      Uint32 RegLvalue, 
      Uint32 RegRvalue, 
      Uint32 Label
    )

成功时返回 0，否则返回 -1。

如果寄存器值不为 NULL，则分支到解释程序中的标签。

int branch_ne_null
    (
      Uint32 RegLvalue, 
      Uint32 Label
    )

成功返回 0，否则返回 -1。

如果寄存器值为 NULL，则分支到解释程序中的标签。

int branch_ne_null
    (
      Uint32 RegLvalue, 
      Uint32 Label
    )

成功时返回 0，否则返回 -1。

跳转到解释程序中的标签。

int branch_label
    (
      Uint32 Label
    )

如果成功，则返回 0；否则返回 -1。

调用解释程序中的子例程。

int call_sub
    (
      Uint32 Subroutine
    )

如果成功，则返回 0；否则返回 -1。

在解释操作中定义跳转标签。标签从 0 开始自动编号。

int def_label
    (
      int labelNumber
    )

成功返回 labelNumber，否则返回 -1。

在解释程序中定义子例程。

int def_subroutine
    (
      int SubroutineNumber
    )

成功时返回 0，否则返回 -1。

此方法将 NdbOperation 定义为 DELETE 操作。调用 NdbTransaction::execute() 方法时，该操作将从表中删除元组。

virtual int deleteTuple
    (
      void
    )

无.

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

此方法定义具有相等性的搜索条件。如果属性具有给定值，则条件为真。要设置多个属性的搜索条件，请多次调用 equal()；在这种情况下，必须满足所有条件才能选择元组。

如果属性是固定大小的，则其值必须包含所有字节。特别是，Char 值必须使用本地空间填充。如果属性是可变大小的，则其值必须以 1 或 2 个小端长度字节开头（如果其类型为 Long*，则为 2 个）。

使用 insertTuple() 时，您也可以使用 setValue() 定义搜索键。请参阅 NdbOperation::setValue()。

equal() 有 10 个版本，每个版本的参数略有不同。所有这些都显示在这里

int  equal
    (
      const char* name,
      const char* value
    )

int  equal
    (
      const char* name,
      Int32       value
    )

int  equal
    (
      const char* name,
      Uint32      value
    )

int  equal
    (
      const char* name,
      Int64       value
    )

int  equal
    (
      const char* name,
      Uint64      value
    )

int  equal
    (
      Uint32      id,
      const char* value
    )

int  equal
    (
      Uint32 id,
      Int32  value
    )

int  equal
    (
      Uint32 id,
      Uint32 value
    )

int  equal
    (
      Uint32 id,
      Int64  value
    )

int  equal
    (
      Uint32 id,
      Uint64 value
    )

此方法需要两个参数

如果发生错误，则返回 -1。

此方法用于代替 getValue() 或 setValue() 用于 blob 属性。它创建一个 blob 句柄（NdbBlob 对象）。使用相同参数的第二次调用将返回先前创建的句柄。该句柄链接到操作并自动维护。

此方法有两种形式，具体取决于它是使用 blob 属性的名称还是 ID 调用的

virtual NdbBlob* getBlobHandle
    (
      const char* name
    )

或

virtual NdbBlob* getBlobHandle
    (
      Uint32 id
    )

此方法采用单个参数，该参数可以是以下任意一个

无论使用哪种参数类型，此方法都返回指向 NdbBlob 实例的指针。

返回指向当前操作的锁句柄的指针。与 NdbRecord 一起使用时，必须首先使用 OO_LOCKHANDLE 操作选项请求锁句柄。对于其他操作，此方法可以单独使用。在任何情况下，在执行操作之前，都不能使用此方法返回的 NdbLockHandle 对象。

const NdbLockHandle* getLockHandle
    (
      void
    ) const

或

const NdbLockHandle* getLockHandle
    (
      void
    )

无.

指向可由 NdbTransaction 方法 unlock() 和 releaseLockHandle() 使用的 NdbLockHandle 的指针。

此方法获取操作的锁模式。

LockMode getLockMode
    (
      void
    ) const

无.

LockMode 值。请参阅 NdbOperation::LockMode。

此方法获取最近的错误（NdbError 对象）。

const NdbError& getNdbError
    (
      void
    ) const

无.

一个 NdbError 对象。

此方法检索最近一次错误发生的 method 编号。

int getNdbErrorLine
    (
      void
    ) const

无.

method 编号（整数）。

此方法用于检索与操作关联的表对象。

const NdbDictionary::Table* getTable
    (
      void
    ) const

无.

指向 Table 实例的指针。

此方法检索用于操作的表的名称。

const char* getTableName
    (
      void
    ) const

无.

表的名称。

获取此操作的 NdbTransaction 对象。

virtual NdbTransaction* getNdbTransaction
    (
      void
    ) const

无.

指向 NdbTransaction 对象的指针。

此方法用于检索此操作的访问类型。

Type getType
    (
      void
    ) const

无.

一个 Type 值。

此方法为检索属性值做准备。NDB API 为 NdbRecAttr 对象分配内存，该对象稍后将用于获取属性值。这可以通过使用多种 NdbRecAttr 访问器方法之一来完成，具体使用哪种方法取决于属性的数据类型。（这包括通用的 NdbRecAttr::aRef() 方法，它以 char* 的形式检索数据，而不管其实际类型是什么。您应该注意，这不是类型安全的，需要用户进行显式转换。）

此方法不从数据库中获取属性值；在调用 NdbTransaction::execute() 之前，此方法返回的 NdbRecAttr 对象是不可读或不可打印的。

如果特定属性未更改，则对应的 NdbRecAttr 处于 UNDEFINED 状态。可以使用 NdbRecAttr::isNULL() 检查这种情况，在这种情况下，它将返回 -1。

参见 NdbTransaction::execute() 和 NdbRecAttr::isNULL()。

此方法有三个版本，每个版本的参数都不同

NdbRecAttr* getValue
    (
      const char* name,
      char*       value = 0
    )

NdbRecAttr* getValue
    (
      Uint32 id,
      char*  value = 0
    )

NdbRecAttr* getValue
    (
      const NdbDictionary::Column* col,
      char*                        value = 0
    )

这三种形式的方法都有两个参数，第二个参数是可选的（默认为 0）。它们的区别仅在于第一个参数的类型，它可以是以下任意一种

在这三种情况下，第二个参数都是一个字符缓冲区，其中返回一个非 NULL 的属性值。如果属性为 NULL，则它只存储在由此方法返回的 NdbRecAttr 对象中。

如果在 getValue() 方法调用中没有指定 value，或者如果将 0 作为值传递，则 NdbRecAttr 对象将提供用于存储接收数据的内存管理。如果接收数据的最大大小超过一个小固定值，则使用 malloc() 来存储它：对于小尺寸，提供一个小的固定内部缓冲区（32 字节）。此存储由 NdbRecAttr 实例管理；当操作被释放时，例如在事务关闭时，它将被释放；您希望保留的写入此处的任何数据都应在此内存释放之前复制到其他地方。

如果您为 value 传递一个非零指针，则假定它指向一块足以容纳该列最大值的内存区域；任何返回的数据都将写入该位置。该指针应该至少是 32 位对齐的。

索引列不能代替此方法中的表列。如果表列不可用，则可以使用使用 getName() 获取的属性名称来代替。

指向 NdbRecAttr 对象的指针，用于保存属性的值，或者是一个 NULL 指针，表示发生错误。

NdbOperation

此结构用于指定作为 NdbRecord 操作的一部分获取的额外值。

构成此结构的元素如下表所示

不能使用 GetValueSpec 指定 Blob 读取。

解释程序指令，将一个值添加到一个属性。该属性可以通过名称或 ID 指定。因此，此方法有四个版本，它们的参数略有不同，如 签名 下所示。

此指令使用寄存器 6 和 7，并在操作过程中覆盖这些寄存器。

对于扫描和 NdbRecord 操作，请改用 NdbInterpretedCode 接口。

int incValue
    (
      const char* anAttrName, 
      Uint32 aValue
    )

int incValue
    (
      const char* anAttrName, 
      Uint64 aValue
    )

int incValue
    (
      Uint32 anAttrId, 
      Uint32 aValue
    )

int incValue
    (
      Uint32 anAttrId, 
      Uint64 aValue
    )

成功时返回 0，否则返回 -1。

此方法将 NdbOperation 定义为 INSERT 操作。调用 NdbTransaction::execute() 方法时，此操作会向表中添加一个新的元组。

virtual int insertTuple
    (
      void
    )

无.

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

终止整个事务。

int interpret_exit_last_row
    (
      void
    )

无

成功返回 0；否则，返回 -1。

退出解释程序，状态为 NOT OK，并返回一个可选的错误代码（请参见 第 2.4.2 节“NDB 错误代码：按类型”）。

int interpret_exit_nok
    (
      Uint32 ErrorCode
    )

int interpret_exit_nok
    (
      void
    )

成功时返回 0，否则返回 -1。

退出解释程序，状态为 OK。

int interpret_exit_ok
    (
      void
    )

无

成功时返回 0，否则返回 -1。

使用解释程序删除元组。

virtual 
int interpretedDeleteTuple
    (
      void
    )

无.

成功时返回 0，否则返回 -1。

使用解释程序更新元组。

virtual
int interpretedUpdateTuple
    (
      void
    )

无.

成功时返回 0，否则返回 -1。

使用解释程序写入元组。

virtual
int interpretedWriteTuple
    (
      void
    )

无.

成功时返回 0，否则返回 -1。

将 32 位常量值加载到寄存器中。

int load_const_u32
    (
      Uint32 RegDest, 
      Uint32 Constant
    )

成功时返回 0，否则返回 -1。

将 64 位常量值加载到寄存器中。

int load_const_u64
    (
      Uint64 RegDest, 
      Uint64 Constant
    )

成功时返回 0，否则返回 -1。

将 NULL 加载到寄存器中。

int load_const_null
    (
      Uint32 RegDest
    )

成功时返回 0，否则返回 -1。

此类型描述执行读取操作时使用的锁模式。

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

还支持脏读（LM_Dirty），但这通常仅用于内部目的，不应在生产环境中部署的应用程序中使用。

NdbOperation

这些选项被传递给 NdbRecord 基于主键和扫描接管操作方法，这些方法定义在 NdbTransaction 和 NdbScanOperation 类中。

大多数 NdbTransaction::*Tuple() 方法（请参阅第 2.3.25 节 “NdbTransaction 类”）都接受一个补充的 sizeOfOptions 参数。 这是可选的，旨在允许接口实现保持与可能传递旧（较小）版本的 OperationOptions 结构的旧未重新编译客户端的向后兼容性。 通过将 sizeof(OperationOptions) 传递到此参数来实现此效果。

每个选项类型都通过在 optionsPresent 中设置相应的位来标记为存在。（只有在 optionsPresent 中标记的选项类型需要合理的数据。）所有数据在操作定义时从 OperationOptions 结构（以及任何子结构）中复制出来。如果不需要任何选项，则可以传递 NULL。

构成此结构的元素如下表所示

将由名称或 ID 标识的属性读入寄存器。

int read_attr
    (
      const char* anAttrName, 
      Uint32 RegDest
    )

int read_attr
    (
      Uint32 anAttrId, 
      Uint32 RegDest
    )

成功时返回 0；否则返回 -1。

此方法将 NdbOperation 定义为 READ 操作。调用 NdbTransaction::execute() 方法时，该操作将读取一个元组。

virtual int readTuple
    (
      LockMode mode
    )

mode 指定读取操作使用的锁定模式。有关可能的值，请参阅NdbOperation::LockMode。

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

从解释程序子例程返回。

int ret_sub
    (
      void
    )

无.

成功时返回 0，否则返回 -1。

此方法定义要设置或更新的属性。

有许多 NdbOperation::setValue() 方法接受某种类型作为输入（按值传递而不是传递指针）。应用程序员有责任使用正确的类型。

NDB API 确实会检查应用程序是否按照 length 参数中给出的长度向接口发送了正确的长度。char* 值可以包含任何数据类型或任何类型的数组。如果未提供长度，或者将其设置为零，则 API 假定指针正确，并且不检查它。

要设置 NULL 值，请使用以下结构

setValue("ATTR_NAME", (char*)NULL);

当您使用 insertTuple() 时，NDB API 会自动检测到它应该改用 equal()。

此外，在使用 insertTuple() 时，不必在其他属性之前对键属性使用 setValue()。

有 14 个版本的 NdbOperation::setValue()，每个版本的参数略有不同，如下所示

int setValue
    (
      const char* name,
      const char* value
)

int setValue
    (
      const char* name,
      Int32       value
    )

int setValue
    (
      const char* name,
      Uint32      value
    )

int setValue
    (
      const char* name,
      Int64       value
    )

int setValue
    (
      const char* name,
      Uint64      value
    )

int setValue
    (
      const char* name,
      float       value
    )

int setValue
    (
      const char* name,
      double      value
    )

int setValue
    (
      Uint32      id,
      const char* value
    )

int setValue
    (
      Uint32 id,
      Int32  value
    )

int setValue
    (
      Uint32 id,
      Uint32 value
    )

int setValue
    (
      Uint32 id,
      Int64  value
    )

int setValue
    (
      Uint32 id,
      Uint64 value
    )

int setValue
    (
      Uint32 id,
      float  value
    )

int setValue
    (
      Uint32 id,
      double value
    )

此方法需要以下两个参数

如果失败，则返回 -1。

NdbOperation

此结构用于指定要作为 NdbRecord 操作的一部分设置的额外值。

构成此结构的元素如下表所示

将两个寄存器值的差存储在第三个寄存器中。

int sub_reg
    (
      Uint32 RegSource1, 
      Uint32 RegSource2, 
      Uint32 RegDest
    )

成功时返回 0，否则返回 -1。

解释程序指令，用于从解释操作中的属性中减去一个值。属性可以通过名称或 ID 指定。 因此，此方法有四个版本的参数略有不同，如签名 下所示。

与 incValue() 一样，此指令使用寄存器 6 和 7，并在其操作过程中覆盖这些寄存器。

对于扫描和 NdbRecord 操作，请改用 NdbInterpretedCode 接口。

int subValue
    (
      const char* anAttrName, 
      Uint32 aValue
    )

int subValue
    (
      const char* anAttrName, 
      Uint64 aValue
    )

int subValue
    (
      Uint32 anAttrId, 
      Uint32 aValue
    )

int subValue
    (
      Uint32 anAttrId, 
      Uint64 aValue
    )

成功时返回 0，否则返回 -1。

Type 用于描述操作访问类型。每个访问类型都由 NdbOperation 或其子类之一支持，如下表所示

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

此方法将 NdbOperation 定义为 UPDATE 操作。调用 NdbTransaction::execute() 方法时，该操作将更新表中找到的元组。

virtual int updateTuple
    (
      void
    )

无.

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

从寄存器写入属性值。要写入的属性可以通过名称或 ID 指定。

int write_attr
    (
      const char* anAttrName, 
      Uint32 RegSource
    )

int write_attr
    (
      Uint32 anAttrId, 
      Uint32 RegSource
    )

成功返回 0；否则，返回 -1。

此方法将 NdbOperation 定义为 WRITE 操作。调用 NdbTransaction::execute() 方法时，该操作会将一个元组写入表中。如果元组已存在，则更新它；否则进行插入。

virtual int writeTuple
    (
      void
    )

无.

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