Description.  This method closes a transaction. It is equivalent to calling Ndb::closeTransaction().

Signature. 

void close
    (
      void
    )

Parameters.  None.

Return value.  None.

Description.  This method gets the transaction's commit status.

Signature. 

CommitStatusType commitStatus
    (
      void
    )

Parameters.  None.

Return value.  The commit status of the transaction, a CommitStatusType value. See Section 2.3.28.1.2, “The NdbTransaction::CommitStatusType Type”.

Description.  Deletes a tuple using NdbRecord.

Signature. 

const NdbOperation* deleteTuple
    (
      const NdbRecord* key_rec, 
      const char* key_row,
      const NdbRecord* result_rec, 
      char* result_row,
      const unsigned char* result_mask = 0,
      const NdbOperation::OperationOptions* opts = 0,
      Uint32 sizeOfOptions = 0
    )

Parameters.  This method takes the following parameters:

Return value.  A const pointer to the NdbOperation representing this write operation. The operation can be checked for errors if necessary.

Signature (“old” version).  Prior to MySQL Cluster NDB 6.2.15 and 6.3.15, this method was defined as shown here:

NdbOperation* deleteTuple
    (
      const NdbRecord* key_rec,
      const char* key_row
    )

Parameters (“old” version).  Prior to MySQL Cluster NDB 6.2.15 and 6.3.15, this method took the following parameters:

Return Value (“old” version).  A pointer to the NdbOperation representing this write operation. The operation can be checked for errors if necessary.

Description.  This method is used to execute a transaction.

Signature. 

int execute
    (
      ExecType execType,
      NdbOperation::AbortOption abortOption = NdbOperation::DefaultAbortOption,
      int force = 0
    )

Parameters.  The execute method takes the three parameters listed here:

Return value.  Returns 0 on success, or -1 on failure. The fact that the transaction did not abort does not necessarily mean that each operation was successful; you must check each operation individually for errors.

In MySQL 5.1.15 and earlier versions, this method returned -1 for some errors even when the trasnsaction itself was not aborted; beginning with MySQL 5.1.16, this method reports a failure if and only if the transaction was aborted. (This change was made due to the fact it had been possible to construct cases where there was no way to determine whether or not a transaction was actually aborted.) However, the transaction's error information is still set in such cases to reflect the actual error code and category.

This means, in the case where a NoDataFound error is a possibility, you must now check for it explicitly, as shown in this example:

Ndb_cluster_connection myConnection;

if( myConnection.connect(4, 5, 1) )
{
  cout << "Unable to connect to cluster within 30 secs." << endl;
  exit(-1);
}

Ndb myNdb(&myConnection, "test");

//  define operations...

myTransaction = myNdb->startTransaction();

if(myTransaction->getNdbError().classification == NdbError:NoDataFound)
{
  cout << "No records found." << endl;
  //  ...
}

myNdb->closeTransaction(myTransaction);

Description.  This method retrieves the transaction's global checkpoint ID (GCI).

Each committed transaction belongs to a GCI. The log for the committed transaction is saved on disk when a global checkpoint occurs.

By comparing the GCI of a transaction with the value of the latest GCI restored in a restarted NDB Cluster, you can determine whether or not the transaction was restored.

Signature. 

int getGCI
    (
      void
    )

Parameters.  None.

Return value.  The transaction's GCI, or -1 if none is available.

Description.  Gets the current batch size in bytes for BLOB read operations. When the volume of BLOB data to be read within a given transaction exceeds this amount, all of the transaction's pending BLOB read operations are executed.

This method was introduced in MySQL Cluster NDB 7.0.21 and MySQL Cluster NDB 7.1.10.

Signature. 

Uint32 getMaxPendingBlobReadBytes
    (
      void
    ) const

Parameters.  None.

Return value.  The current BLOB read batch size, in bytes. See Section 2.3.28.2.23, “NdbTransaction::setMaxPendingBlobReadBytes()”, for more information.

Description.  Gets the current batch size in bytes for BLOB write operations. When the volume of BLOB data to be written within a given transaction exceeds this amount, all of the transaction's pending BLOB write operations are executed.

This method was introduced in MySQL Cluster NDB 7.0.21 and MySQL Cluster NDB 7.1.10.

Signature. 

Uint32 getMaxPendingBlobWriteBytes
    (
      void
    ) const

Parameters.  None.

Return value.  The current BLOB write batch size, in bytes. See Section 2.3.28.2.24, “NdbTransaction::setMaxPendingBlobWriteBytes()”, for more information.

Description.  This method is used to obtain the most recent error (NdbError).

Signature. 

const NdbError& getNdbError
    (
      void
    ) const

Parameters.  None.

Return value.  A reference to an NdbError object.

Description.  This method return the line number where the most recent error occurred.

Signature. 

int getNdbErrorLine
    (
      void
    )

Parameters.  None.

Return value.  The line number of the most recent error.

Description.  This method retrieves the operation that caused an error.

Signature. 

NdbOperation* getNdbErrorOperation
    (
      void
    )

Parameters.  None.

Return value.  A pointer to an NdbOperation.

Description.  This method is used to create an NdbIndexOperation associated with a given table.

Signature. 

NdbIndexOperation* getNdbIndexOperation
    (
      const NdbDictionary::Index* index
    )

Parameters.  The Index object on which the operation is to be performed.

Return value.  A pointer to the new NdbIndexOperation.

Description.  This method is used to create an NdbIndexScanOperation associated with a given table.

Signature. 

NdbIndexScanOperation* getNdbIndexScanOperation
    (
      const NdbDictionary::Index* index
    )

Parameters.  The Index object on which the operation is to be performed.

Return value.  A pointer to the new NdbIndexScanOperation.

Description.  This method is used to create an NdbOperation associated with a given table.

Signature. 

NdbOperation* getNdbOperation
    (
      const NdbDictionary::Table* table
    )

Parameters.  The Table object on which the operation is to be performed.

Return value.  A pointer to the new NdbOperation.

Description.  This method is used to create an NdbScanOperation associated with a given table.

Signature. 

NdbScanOperation* getNdbScanOperation
    (
      const NdbDictionary::Table* table
    )

Parameters.  The Table object on which the operation is to be performed.

Return value.  A pointer to the new NdbScanOperation.

Description.  This method is used to retrieve a transaction's completed operations. It is typically used to fetch all operations belonging to a given transaction to check for errors.

NdbTransaction::getNextCompletedOperation(NULL) returns the transaction's first NdbOperation object; NdbTransaction::getNextCompletedOperation(myOp) returns the NdbOperation object defined after NdbOperation myOp.

Signature. 

const NdbOperation* getNextCompletedOperation
    (
      const NdbOperation* op
    ) const

Parameters.  This method requires a single parameter op, which is an operation (NdbOperation object), or NULL.

Return value.  The operation following op, or the first operation defined for the transaction if getNextCompletedOperation() was called using NULL.

Description.  This method is used to obtain the transaction ID.

Signature. 

Uint64 getTransactionId
    (
      void
    )

Parameters.  None.

Return value.  The transaction ID, as an unsigned 64-bit integer.

Description.  Inserts a tuple using NdbRecord.

Signature. 

const NdbOperation* insertTuple
    (
      const NdbRecord* key_rec, 
      const char* key_row,
      const NdbRecord* attr_rec, 
      const char* attr_row,
      const unsigned char* mask = 0,
      const NdbOperation::OperationOptions* opts = 0,
      Uint32 sizeOfOptions = 0
    )

Parameters.  insertTuple() takes the following parameters:

This method can also be called using a single NdbRecord pointer and single char pointer (combined_rec, combined_row) where the single NdbRecord represents record and attribute and data.

Return value.  A const pointer to the NdbOperation representing this insert operation.

Signature (“old” version).  Prior to MySQL Cluster NDB 6.2.15 and MySQL Cluster NDB 6.3.15, this method was defined as follows:

NdbOperation* insertTuple
    (
      const NdbRecord* record,
      const char* row,
      const unsigned char* mask = 0
    )

Parameters (“old” version).  Prior to MySQL Cluster NDB 6.2.15 and 6.3.15, insertTuple() took the following parameters:

Return Value (“old” version).  Prior to MySQL Cluster NDB 6.2.15 and 6.3.15, this method returned a pointer to the NdbOperation representing the insert operation.

Description.  This method reads a tuple using NdbRecord objects.

Signature. 

const NdbOperation* readTuple
    (
      const NdbRecord* key_rec, 
      const char* key_row,
      const NdbRecord* result_rec, 
      char* result_row,
      NdbOperation::LockMode lock_mode = NdbOperation::LM_Read,
      const unsigned char* result_mask = 0,
      const NdbOperation::OperationOptions* opts = 0,
      Uint32 sizeOfOptions = 0
    )

Parameters.  This method takes the following parameters:

Return value.  A pointer to the NdbOperation representing this read operation (this can be used to check for errors).

Signature (“old” version).  Prior to MySQL Cluster NDB 6.2.15 and 6.3.15, this method was defined as shown here:

NdbOperation* readTuple
    (
      const NdbRecord* key_rec,
      const char* key_row,
      const NdbRecord* result_rec,
      char* result_row,
      NdbOperation::LockMode lock_mode = NdbOperation::LM_Read,
      const unsigned char* result_mask = 0
    )

Parameters (“old” version).  Prior to MySQL Cluster NDB 6.2.15 and 6.3.15, this method took the following parameters:

Return value (“old” version).  A pointer to the NdbOperation representing this operation (this can be used to check for errors).

Description.  This method updates the transaction's timeout counter, and thus avoids aborting due to transaction timeout.

Signature. 

int refresh
    (
      void
    )

Parameters.  None.

Return value.  Returns 0 on success, -1 on failure.

Description.  This method is used to release a lock handle (see Section 2.3.23.2.4, “NdbOperation::getLockHandle”) when it is no longer required. For NdbRecord primary key read operations, this cannot be called until the associated read operation has been executed.

Signature. 

int releaseLockHandle
    (
      const NdbLockHandle* lockHandle
    )

Parameters.  The NdbLockHandle object to be released.

Return value.  0 on success.

Description.  Perform an index range scan of a table, with optional ordering.

The signature for this method changed in MySQL Cluster NDB 6.3.8. Information about the old-style signature follows later in this section.

Signature (MySQL Cluster NDB 6.3.8 and later). 

NdbIndexScanOperation* scanIndex
    (
      const NdbRecord* key_record,
      const NdbRecord* result_record,
      NdbOperation::LockMode lock_mode = NdbOperation::LM_Read,
      const unsigned char* result_mask = 0,
      const NdbIndexScanOperation::IndexBound* bound = 0,
      const NdbScanOperation::ScanOptions* options = 0,
      Uint32 sizeOfOptions = 0
    )

Parameters (MySQL Cluster NDB 6.3.8 and later).  The key_record describes the index to be scanned. It must be a key record for the index; that is, it must specify, at a minimum, all of the key columns of the index. The key_record must be created from the index to be scanned (and not from the underlying table).

The result_record describes the rows to be returned from the scan. For an ordered index scan, result_record must be a key record for the index to be scanned; that is, it must include (at a minimum) all of the columns in the index (the full index key is needed by the NDB API for merge-sorting the ordered rows returned from each fragment).

Like the key_record, the result_record must be created from the underlying table, and not from the index to be scanned. Both the key_record and result_record NdbRecord structures must stay in place until the scan operation is closed.

A single IndexBound can be specified either in this call or in a separate call to NdbIndexScanOperation::setBound(). To perform a multi-range read, the scan_flags in the ScanOptions structure must include SF_MULTIRANGE. Additional bounds can be added using successive calls to NdbIndexScanOperation::setBound().

To specify an equals bound, use the same row pointer for the low_key and high_key with the low and high inclusive bits set.

To specify additional options, pass a ScanOptions structure.

The sizeOfOptions exists To enable backwards compatability for this interface. This parameter indicates the size of the ScanOptions structure at the time the client was compiled, and enables detection of the use of an old-style ScanOptions structure. If this functionality is not required, this argument can be left set to 0.

The parameters used by this method changed in MySQL Cluster NDB 6.3.8. Information about the old-style parameters follows later in this section.

Return value.  The current NdbIndexScanOperation, which can be used for error checking.

Signature (old style). 

NdbIndexScanOperation* scanIndex
    (
      const NdbRecord* key_record,
      const char* low_key,
      Uint32 low_key_count,
      bool low_inclusive,
      const char* high_key,
      Uint32 high_key_count,
      bool high_inclusive,
      const NdbRecord* result_record,
      NdbOperation::LockMode lock_mode = NdbOperation::LM_Read,
      const unsigned char* result_mask = 0,
      Uint32 scan_flags = 0,
      Uint32 parallel = 0,
      Uint32 batch = 0
    )

Parameters (old style).  This method takes the following parameters:

Description.  This method performs a table scan, using an NdbRecord object to read out column data.

Signature. 

NdbScanOperation* scanTable
    (
      const NdbRecord* result_record,
      NdbOperation::LockMode lock_mode = NdbOperation::LM_Read,
      const unsigned char* result_mask = 0,
      Uint32 scan_flags = 0,
      Uint32 parallel = 0,
      Uint32 batch = 0
    )

Parameters.  The scanTable() method takes the following parameters:

Return value.  A pointer to the NdbScanOperation representing this scan. The operation can be checked for errors if necessary.

Description.  Sets the batch size in bytes for BLOB read operations. When the volume of BLOB data to be read within a given transaction exceeds this amount, all of the transaction's pending BLOB read operations are executed.

This method was introduced in MySQL Cluster NDB 7.0.21 and MySQL Cluster NDB 7.1.10.

Signature. 

void setMaxPendingBlobReadBytes
    (
      Uint32 bytes
    )

Parameters.  The batch size, as the number of bytes. Using 0 causes BLOB read batching to be disabled, which is the default behavior (for backward compatibility).

Return value.  None.

Description.  Sets the batch size in bytes for BLOB write operations. When the volume of BLOB data to be written within a given transaction exceeds this amount, all of the transaction's pending BLOB write operations are executed.

This method was introduced in MySQL Cluster NDB 7.0.21 and MySQL Cluster NDB 7.1.10.

Signature. 

void setMaxPendingBlobWriteBytes
    (
      Uint32 bytes
    )

Parameters.  The batch size, as the number of bytes. Using 0 causes BLOB write batching to be disabled, which is the default behavior (for backward compatibility).

Return value.  None.

Description.  This method creates an unlock operation on the current transaction; when executed, the unlock operation removes the lock referenced by the NdbLockHandle (see Section 2.3.23.2.4, “NdbOperation::getLockHandle”) passed to the method.

Signature. 

const NdbOperation* unlock
    (
      const NdbLockHandle* lockHandle,
      NdbOperation::AbortOption ao = NdbOperation::DefaultAbortOption
    )

Parameters.  A pointer to a lock handle; in addition, optionally, an AbortOption value ao.

In the event that the unlock operation fails—for example, due to the row already being unlocked—the AbortOption specifies how this is handled, the default being that errors cause transactions to abort.

Return value.  A pointer to an NdbOperation (the unlock operation created).

Description.  Updates a tuple using an NdbRecord object.

Signature. 

const NdbOperation* updateTuple
    (
      const NdbRecord* key_rec, 
      const char* key_row,
      const NdbRecord* attr_rec, 
      const char* attr_row,
      const unsigned char* mask = 0,
      const NdbOperation::OperationOptions* opts = 0,
      Uint32 sizeOfOptions = 0
    )

Parameters.  updateTuple() takes the following parameters:

Return value.  The NdbOperation representing this operation (can be used to check for errors).

Old version.  Prior to MySQL Cluster NDB 6.2.15 and 6.3.15, this method was defined as follows:

NdbOperation* updateTuple
    (
      const NdbRecord* key_rec,
      const char* key_row,
      const NdbRecord* attr_rec,
      const char* attr_row,
      const unsigned char* mask = 0
    )

Parameters (“old” version).  Prior to MySQL Cluster NDB 6.2.15 and 6.3.15, updateTuple() took the following parameters:

Return Value (“old” version).  Prior to MySQL Cluster NDB 6.2.15 and 6.3.15, this method returned a pointer to the NdbOperation representing this operation (which could be used to check for errors).

Description.  This method is used with NdbRecord to write a tuple of data.

Signature. 

const NdbOperation* writeTuple
    (
      const NdbRecord* key_rec,
      const char* key_row,
      const NdbRecord* attr_rec,
      const char* attr_row,
      const unsigned char* mask = 0,
      const NdbOperation::OperationOptions* opts = 0,
      Uint32 sizeOfOptions = 0
    )

Parameters.  This method takes the following parameters:

Return value.  A const pointer to the NdbOperation representing this write operation. The operation can be checked for errors if and as necessary.

Signature (“old” version).  Prior to MySQL Cluster NDB 6.2.15 and 6.3.15, this method was defined as shown here:

NdbOperation* writeTuple
    (
      const NdbRecord* key_rec,
      const char* key_row,
      const NdbRecord* attr_rec,
      const char* attr_row,
      const unsigned char* mask = 0
    )

Parameters (“old” version).  Prior to MySQL Cluster NDB 6.2.15 and 6.3.15, this method took the following parameters:

Return Value (“old” version).  Prior to MySQL Cluster NDB 6.2.15 and 6.3.15, this method returned a pointer to the NdbOperation representing this write operation. The operation could be checked for errors if and as necessary.