Skip navigation links
2.3.13 The NdbIndexScanOperation Class »
Section Navigation      [Toggle]

2.3.12.1. NdbIndexOperation Methods

[+/-]

2.3.12.1.1. NdbIndexOperation::getIndex()
2.3.12.1.2. NdbIndexOperation::readTuple()
2.3.12.1.3. NdbIndexOperation::updateTuple()
2.3.12.1.4. NdbIndexOperation::deleteTuple()

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. See Section 2.3.19.2.4, “NdbTransaction::getNdbIndexOperation()”.

2.3.12.1.1. NdbIndexOperation::getIndex()

Description. 

Signature.  

const NdbDictionary::Index* getIndex
    (
      void
    ) const

Parameters.  None.

Return value.  A pointer to an Index object. See Section 2.3.5, “The Index Class”.

2.3.12.1.2. NdbIndexOperation::readTuple()

Description.  This method define the NdbIndexOperation as a READ operation. When the NdbTransaction::execute() method is invoked, the operation reads a tuple. See Section 2.3.19.2.5, “NdbTransaction::execute()”.

Signature.  

int readTuple
    (
      LockMode mode
    )

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

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

2.3.12.1.3. 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. See Section 2.3.19.2.5, “NdbTransaction::execute()”.

Signature.  

int updateTuple
    (
      void
    )

Parameters.  None.

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

2.3.12.1.4. 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. See Section 2.3.19.2.5, “NdbTransaction::execute()”.

Signature.  

int deleteTuple
    (
      void
    )

Parameters.  None.

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