MySQL :: MySQL Cluster API Developer Guide :: 2.3.20.1 NdbIndexOperation Methods

MySQL Cluster API Developer Guide :: 2 The NDB API :: 2.3 NDB API Classes, Interfaces, and Structures :: 2.3.20 The NdbIndexOperation Class :: 2.3.20.1 NdbIndexOperation Methods

« 2.3.20 The NdbIndexOperation Class

2.3.21 The NdbIndexScanOperation Class »

Section Navigation [Toggle]

2.3.20 The NdbIndexOperation Class
2.3.20.1 NdbIndexOperation Methods

2.3.20.1. `NdbIndexOperation` Methods

[+/-]

2.3.20.1.1. NdbIndexOperation::deleteTuple()
2.3.20.1.2. NdbIndexOperation::getIndex()
2.3.20.1.3. NdbIndexOperation::readTuple()
2.3.20.1.4. NdbIndexOperation::updateTuple()

Abstract

This section lists and describes the public methods of the NdbIndexOperation class.

Note

This class has no public constructor. To create an instance of NdbIndexOperation, it is necessary to use the NdbTransaction::getNdbIndexOperation() method.

2.3.20.1.1. `NdbIndexOperation::deleteTuple()`

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

Signature.

int deleteTuple
    (
      void
    )

Parameters. None.

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

2.3.20.1.2. `NdbIndexOperation::getIndex()`

Description. Gets the index, given an index operation.

Signature.

const NdbDictionary::Index* getIndex
    (
      void
    ) const

Parameters. None.

Return value. A pointer to an Index object.

2.3.20.1.3. `NdbIndexOperation::readTuple()`

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

Signature.

int readTuple
    (
      LockMode mode
    )

Parameters. mode specifies the locking mode used by the read operation. See Section 2.3.23.1.2, “The NdbOperation::LockMode Type”, for possible values.

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

2.3.20.1.4. `NdbIndexOperation::updateTuple()`

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

Signature.

int updateTuple
    (
      void
    )

Parameters. None.

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

Top / Previous / Next / Up / Table of Contents

2.3.20.1. NdbIndexOperation Methods

2.3.20.1.1. NdbIndexOperation::deleteTuple()

2.3.20.1.2. NdbIndexOperation::getIndex()

2.3.20.1.3. NdbIndexOperation::readTuple()

2.3.20.1.4. NdbIndexOperation::updateTuple()

2.3.20.1. `NdbIndexOperation` Methods

2.3.20.1.1. `NdbIndexOperation::deleteTuple()`

2.3.20.1.2. `NdbIndexOperation::getIndex()`

2.3.20.1.3. `NdbIndexOperation::readTuple()`

2.3.20.1.4. `NdbIndexOperation::updateTuple()`