None

NdbIndexOperation, NdbScanOperation

NdbOperation represents a “generic” data operation. Its subclasses represent more specific types of operations. See NdbOperation::Type for a listing of operation types and their corresponding NdbOperation subclasses.

The following table lists the public methods of this class and the purpose or use of each method:

This class has no public constructor. To create an instance of NdbOperation, you must use NdbTransaction::getNdbOperation().

The NdbOperation class defines three public types, shown in the following table:

This type is used to determine whether failed operations should force a transaction to be aborted. It is used as an argument to the execute() method—see NdbTransaction::execute(), for more information.

Possible values are shown, along with descriptions, in the following table:

Add contents of two registers; store result in a third register.

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

0 on success, otherwise -1.

Branch to a label in an interpreted program if the specified column is NULL.

int branch_col_eq_null
    (
      Uint32 ColId, 
      Uint32 Label
    )
  

0 on success, otherwise -1.

Branch to a label in an interpreted program if the specified column is not NULL.

int branch_col_ne_null
    (
      Uint32 ColId, 
      Uint32 Label
    )
  

none

Branch to a label in an interpreted program if a given value is equal to the value of the specified column.

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

0 on success, -1 otherwise.

Branch to a label in an interpreted program if a given value is not equal to the value of the specified column.

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

0 on success, else -1.

Branch to a label in an interpreted program if a given value is less than a column value.

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

0 on success, otherwise -1.

Branch to a label in an interpreted program if a given value is less than or equal to a column value.

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

On success, 0; otherwise, -1.

Branch to a label in an interpreted program if a given value is greater than a column value.

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

0 on success, -1 otherwise.

Branch to a label in an interpreted program if a given value is greater than or equal to a column value.

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

0 if successful, else -1.

Branch if the column value matches a wildcard pattern. This method and branch_col_notlike() each support the wildcards used by the MySQL LIKE operator: % for any string of 0 or more characters, and _ for any single character.

The column's type must be one of CHAR, VARCHAR, BINARY, or VARBINARY.

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

0 on success, otherwise -1.

Branch if the column value does not match the given wildcard pattern. This method and branch_col_like() each support the same wildcards % (0 or more characters) and _ (any one character) as the MySQL LIKE operator.

The column's type must be one of CHAR, VARCHAR, BINARY, or VARBINARY.

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

0 on success, -1 otherwise.

Branch if the value of a column in a logical bitwise AND with a bitmask is equal to the bitmask.

See also Bitwise logical comparisons.

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

0 on success, -1 otherwise.

Branch if the value of a column in a logical bitwise AND with a bitmask is not equal to the bitmask.

See also Bitwise logical comparisons.

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

On success 0, else -1.

Branch if the value of a column in a logical bitwise AND with a bitmask is equal to 0.

See also Bitwise logical comparisons.

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

0 on success, -1 otherwise.

Branch if the value of a column in a logical bitwise AND with a bitmask is not equal to 0.

See also Bitwise logical comparisons.

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

Returns 0 on success, -1 otherwise.

Define a search condition in an interpreted program. Compares the right-hand register value with the left; branch to a label if the RH value is greater than or equal to the LH value.

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

0 on success, -1 otherwise.

Define a search condition in an interpreted program. Compares the right-hand register value with the left; branch to a label if the RH value is greater than the LH value.

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

0 on success, -1 otherwise.

Define a search condition in an interpreted program. Compares the right-hand register value with the left; branch to a label if the RH value is less than the LH value.

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

0 on success, -1 otherwise.

Define a search condition in an interpreted program. Compares the right-hand register value with the left; branch to a label if the RH value is less than or equal to the LH value.

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

0 on success, -1 otherwise.

Branch to a label in an interpreted program when two register values are equal.

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

0 on success, -1 otherwise.

Branch to a label in an interpreted program when two register values are not equal.

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

0 on success, otherwise -1.

Branch to a label in an interpeted program if a register value is not NULL.

int branch_ne_null
    (
      Uint32 RegLvalue, 
      Uint32 Label
    )

On success, returns 0; otherwise, returns -1.

Branch to a label in an interpeted program if a register value is NULL.

int branch_ne_null
    (
      Uint32 RegLvalue, 
      Uint32 Label
    )

On success, 0; otherwise, -1.

Jump to a label in an interpeted progam.

int branch_label
    (
      Uint32 Label
    )
  

0 if successful; otherwise, -1.

Call a subroutine in an interpeted program.

int call_sub
    (
      Uint32 Subroutine
    )

If successful, returns 0; otherwise, returns -1.

Define a jump label in an interpreted operation. Labels are numbered automatically starting with 0.

int def_label
    (
      int labelNumber
    )

labelNumber on success, -1 otherwise.

Define a subroutine in an interpreted program.

int def_subroutine
    (
      int SubroutineNumber
    )

0 on success, -1 otherwise.

This method defines the NdbOperation as a DELETE operation. When the NdbTransaction::execute() method is invoked, the operation deletes a tuple from the table.

virtual int deleteTuple
    (
      void
    )

None.

Returns 0 on success, -1 on failure.

This method defines a search condition with an equality. The condition is true if the attribute has the given value. To set search conditions on multiple attributes, use several calls to equal(); in such cases all of them must be satisfied for the tuple to be selected.

If the attribute is of a fixed size, its value must include all bytes. In particular a Char value must be native-space padded. If the attribute is of variable size, its value must start with 1 or 2 little-endian length bytes (2 if its type is Long*).

When using insertTuple(), you may also define the search key with setValue(). See NdbOperation::setValue().

There are 10 versions of equal(), each having slightly different parameters. All of these are shown here:

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
    )

This method requires two parameters:

Returns -1 in the event of an error.

This method is used in place of getValue() or setValue() for blob attributes. It creates a blob handle (NdbBlob object). A second call with the same argument returns the previously created handle. The handle is linked to the operation and is maintained automatically.

This method has two forms, depending on whether it is called with the name or the ID of the blob attribute:

virtual NdbBlob* getBlobHandle
    (
      const char* name
    )

or

virtual NdbBlob* getBlobHandle
    (
      Uint32 id
    )

This method takes a single parameter, which can be either one of the following:

Regardless of parameter type used, this method return a pointer to an instance of NdbBlob.

Returns a pointer to the current operation's lock handle. When used with NdbRecord, the lock handle must first be requested with the OO_LOCKHANDLE operation option. For other operations, this method can be used alone. In any case, the NdbLockHandle object returned by this method cannot be used until the operation has been executed.

const NdbLockHandle* getLockHandle
    (
      void
    ) const

or

const NdbLockHandle* getLockHandle
    (
      void
    )

None.

Pointer to an NdbLockHandle that can be used by the NdbTransaction methods unlock() and releaseLockHandle().

This method gets the operation's lock mode.

LockMode getLockMode
    (
      void
    ) const

None.

A LockMode value. See NdbOperation::LockMode.

This method gets the most recent error (an NdbError object).

const NdbError& getNdbError
    (
      void
    ) const

None.

An NdbError object.

This method retrieves the method number in which the latest error occurred.

int getNdbErrorLine
    (
      void
    ) const

None.

The method number (an integer).

This method is used to retrieve the table object associated with the operation.

const NdbDictionary::Table* getTable
    (
      void
    ) const

None.

A pointer to an instance of Table.

This method retrieves the name of the table used for the operation.

const char* getTableName
    (
      void
    ) const

None.

The name of the table.

Gets the NdbTransaction object for this operation.

virtual NdbTransaction* getNdbTransaction
    (
      void
    ) const

None.

A pointer to an NdbTransaction object.

This method is used to retrieve the access type for this operation.

Type getType
    (
      void
    ) const

None.

A Type value.

This method prepares for the retrieval of an attribute value. The NDB API allocates memory for an NdbRecAttr object that is later used to obtain the attribute value. This can be done by using one of the many NdbRecAttr accessor methods, the exact method to be used depending on the attribute's data type. (This includes the generic NdbRecAttr::aRef() method, which retrieves the data as char*, regardless of its actual type. You should be aware that this is not type-safe, and requires an explicit cast from the user.)

This method does not fetch the attribute value from the database; the NdbRecAttr object returned by this method is not readable or printable before calling NdbTransaction::execute().

If a specific attribute has not changed, the corresponding NdbRecAttr has the state UNDEFINED. This can be checked by using NdbRecAttr::isNULL(), which in such cases returns -1.

See NdbTransaction::execute(), and NdbRecAttr::isNULL().

There are three versions of this method, each having different parameters:

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

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

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

All three forms of this method have two parameters, the second parameter being optional (defaults to 0). They differ only with regard to the type of the first parameter, which can be any one of the following:

In all three cases, the second parameter is a character buffer in which a non-NULL attribute value is returned. In the event that the attribute is NULL, is it stored only in the NdbRecAttr object returned by this method.

If no value is specified in the getValue() method call, or if 0 is passed as the value, then the NdbRecAttr object provides memory management for storing the received data. If the maximum size of the received data is above a small fixed size, malloc() is used to store it: For small sizes, a small, fixed internal buffer (32 bytes in extent) is provided. This storage is managed by the NdbRecAttr instance; it is freed when the operation is released, such as at transaction close time; any data written here that you wish to preserve should be copied elsewhere before this freeing of memory takes place.

If you pass a non-zero pointer for value, then it is assumed that this points to an portion of memory which is large enough to hold the maximum value of the column; any returned data is written to that location. The pointer should be at least 32-bit aligned.

Index columns cannot be used in place of table columns with this method. In cases where a table column is not available, you can use the attribute name, obtained with getName(), for this purpose instead.

A pointer to an NdbRecAttr object to hold the value of the attribute, or a NULL pointer, indicating an error.

NdbOperation

This structure is used to specify an extra value to obtain as part of an NdbRecord operation.

The elements making up this structure are shown in the following table:

Blob reads cannot be specified using GetValueSpec.

Interpreted program instruction which adds a value to an attribute. The attribute can be specified by name or by ID. Thus, there are four versions of of this method having slightly different parameters, as shown under Signature.

This instruction uses registers 6 and 7, and overwrites these registers in the course of its operation.

For scans and NdbRecord operations, use the NdbInterpretedCode interface instead.

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 on success, -1 otherwise.

This method defines the NdbOperation to be an INSERT operation. When the NdbTransaction::execute() method is called, this operation adds a new tuple to the table.

virtual int insertTuple
    (
      void
    )

None.

Returns 0 on success, -1 on failure.

Terminate the entire transaction.

int interpret_exit_last_row
    (
      void
    )
  

none

Returns 0 on success; otherwise, returns -1.

Exit interpreted program with status NOT OK and an optional error code (see Section 2.4.2, “NDB Error Codes: by Type”).

int interpret_exit_nok
    (
      Uint32 ErrorCode
    )

int interpret_exit_nok
    (
      void
    )

0 on success, -1 otherwise.

Exit interpreted program with status OK.

int interpret_exit_ok
    (
      void
    )

none

0 on success, -1 otherwise.

Delete a tuple using an interpreted program.

virtual 
int interpretedDeleteTuple
    (
      void
    )

None.

0 on success, -1 otherwise.

Update a tuple using an interpreted program.

virtual
int interpretedUpdateTuple
    (
      void
    )

None.

0 on success, -1 otherwise.

Write a tuple using an interpreted program.

virtual
int interpretedWriteTuple
    (
      void
    )

None.

0 on success, -1 otherwise.

Load a 32-bit constant value into a register.

int load_const_u32
    (
      Uint32 RegDest, 
      Uint32 Constant
    )
  

0 on success, -1 otherwise.

Load a 64-bit constant value into a register.

int load_const_u64
    (
      Uint64 RegDest, 
      Uint64 Constant
    )
  

0 on success, otherwise -1.

Load NULL into a register.

int load_const_null
    (
      Uint32 RegDest
    )

0 on success, -1 otherwise.

This type describes the lock mode used when performing a read operation.

Possible values for this type are shown, along with descriptions, in the following table:

There is also support for dirty reads (LM_Dirty), but this is normally for internal purposes only, and should not be used for applications deployed in a production setting.

NdbOperation

These options are passed to the NdbRecord-based primary key and scan takeover operation methods defined in the NdbTransaction and NdbScanOperation classes.

Most NdbTransaction::*Tuple() methods (see Section 2.3.25, “The NdbTransaction Class”) take a supplementary sizeOfOptions parameter. This is optional, and is intended to permit the interface implementation to remain backward compatible with older un-recompiled clients that may pass an older (smaller) version of the OperationOptions structure. This effect is achieved by passing sizeof(OperationOptions) into this parameter.

Each option type is marked as present by setting the corresponding bit in optionsPresent. (Only the option types marked in optionsPresent need have sensible data.) All data is copied out of the OperationOptions structure (and any subtended structures) at operation definition time. If no options are required, then NULL may be passed instead.

The elements making up this structure are shown in the following table:

Read an attribute identified by name or ID into a register.

int read_attr
    (
      const char* anAttrName, 
      Uint32 RegDest
    )

int read_attr
    (
      Uint32 anAttrId, 
      Uint32 RegDest
    )
  

On success, 0; otheriwse, -1.

This method defines the NdbOperation as a READ operation. When the NdbTransaction::execute() method is invoked, the operation reads a tuple.

virtual int readTuple
    (
      LockMode mode
    )

mode specifies the locking mode used by the read operation. See NdbOperation::LockMode, for possible values.

Returns 0 on success, -1 on failure.

Return from an interpreted program subroutine.

int ret_sub
    (
      void
    )

none.

0 on success, -1 otherwise.

This method defines an attribute to be set or updated.

There are a number of NdbOperation::setValue() methods that take a certain type as input (pass by value rather than passing a pointer). It is the responsibility of the application programmer to use the correct types.

The NDB API does check that the application sends a correct length to the interface as given in the length parameter. A char* value can contain any data type or any type of array. If the length is not provided, or if it is set to zero, then the API assumes that the pointer is correct, and does not check it.

To set a NULL value, use the following construct:

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

When you use insertTuple(), the NDB API automatically detects that it is supposed to use equal() instead.

In addition, it is not necessary when using insertTuple() to use setValue() on key attributes before other attributes.

There are 14 versions of NdbOperation::setValue(), each with slightly different parameters, as listed here:

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
    )

This method requires the following two parameters:

Returns -1 in the event of failure.

NdbOperation

This structure is used to specify an extra value to set as part of an NdbRecord operation.

The elements making up this structure are shown in the following table:

Store difference of two register values in a third register.

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

0 on success, otherwise -1.

Interpreted program instruction which subtracts a value from an attribute in an interpreted operation. The attribute can be specified by name or by ID. Thus, there are four versions of of this method having slightly different parameters, as shown under Signature.

As with incValue(), this instruction uses registers 6 and 7, and overwrites these registers in the course of its operation.

For scans and NdbRecord operations, use the NdbInterpretedCode interface instead.

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 on success, -1 otherwise.

Type is used to describe the operation access type. Each access type is supported by NdbOperation or one of its subclasses, as shown in the following table:

Possible values are shown, along with descriptions, in the following table:

This method defines the NdbOperation as an UPDATE operation. When the NdbTransaction::execute() method is invoked, the operation updates a tuple found in the table.

virtual int updateTuple
    (
      void
    )

None.

Returns 0 on success, -1 on failure.

Write an attribute value from a register. The attribute to be written can be specified by name or ID.

int write_attr
    (
      const char* anAttrName, 
      Uint32 RegSource
    )

int write_attr
    (
      Uint32 anAttrId, 
      Uint32 RegSource
    )
  

Returns 0 on success; otherwise, returns -1.

This method defines the NdbOperation as a WRITE operation. When the NdbTransaction::execute() method is invoked, the operation writes a tuple to the table. If the tuple already exists, it is updated; otherwise an insert takes place.

virtual int writeTuple
    (
      void
    )

None.

Returns 0 on success, -1 on failure.