Abstract
This section describes the NdbScanOperation
class and its class members.
Parent class.
NdbOperation
Child classes.
NdbIndexScanOperation
Description.
The NdbScanOperation class represents a
scanning operation used in a transaction. This class inherits from
NdbOperation.
Beginning with MySQL Cluster NDB 6.2.14 and MySQL Cluster 6.3.12,
you must use the
NdbInterpretedCode class instead
of NdbScanOperation when writing interpreted
programs used for scans.
Methods. The following table lists the public methods of this class and the purpose or use of each method:
| Method | Purpose / Use |
|---|---|
close() | Closes the scan |
deleteCurrentTuple() | Deletes the current tuple |
lockCurrentTuple() | Locks the current tuple |
nextResult() | Gets the next tuple |
getNdbTransaction() | Gets the NdbTransaction object for this
scan |
getPruned() | Used to find out whether this scan is pruned to a single partition |
readTuples() | Reads tuples |
restart() | Restarts the scan |
updateCurrentTuple() | Updates the current tuple |
For detailed descriptions, signatures, and examples of use for each
of these methods, see
Section 2.3.27.2, “NdbScanOperation Methods”.
Types.
This class defines a single public type
ScanFlag.
Class diagram.
This diagram shows all the available members of the
NdbScanOperation class:
For more information about the use of
NdbScanOperation, see
Section 1.3.2.3.2, “Scan Operations”, and
Section 1.3.2.3.3, “Using Scans to Update or Delete Rows”.
Multi-Range Read (MRR) scans using
NdbScanOperation are not supported using MySQL
Cluster NDB 6.2. They are supported for MySQL Cluster NDB 6.3 (and
later) beginning with 6.3.17 (see Bug #38791). Both NDB 6.2 and
NDB 6.3 (as well as later MySQL Cluster releases) support MRR
scans using the NdbRecord
interface.