Abstract
This section discusses the
NdbIndexScanOperation
class and its public
members.
Parent class. NdbScanOperation
Child classes. None
Description.
The NdbIndexScanOperation
class represents a
scan operation using an ordered index. This class inherits from
NdbScanOperation
and
NdbOperation
. See
Section 2.3.18, “The NdbScanOperation
Class”, and
Section 2.3.15, “The NdbOperation
Class”, for more information about
these classes.
NdbIndexScanOperation
is for use with ordered
indexes only; to work with unique hash indexes, use
NdbIndexOperation
.
Methods. The following table lists the public methods of this class and the purpose or use of each method:
Method | Purpose / Use |
---|---|
get_range_no() |
Gets the range number for the current row |
getSorted() |
Checks whether the current scan is sorted |
getDescending() |
Checks whether the current scan is sorted |
readTuples() |
Reads tuples using an ordered index |
setBound() |
Defines a bound on the index key for a range scan |
reset_bounds() |
Resets bounds, puts the operation in the send queue |
end_of_bound() |
Marks the end of a bound |
For detailed descriptions, signatures, and examples of use for each
of these methods, see
Section 2.3.13.2, “NdbIndexScanOperation
Methods”.
Types.
The NdbIndexScanOperation
class defines one
public type. See
Section 2.3.13.1, “The NdbIndexScanOperation::BoundType
Type”.
Beginning with MySQL Cluster NDB 6.2.3, this class defines an
additional struct for use with operations employing
NdbRecord
; see Section 2.3.29, “The IndexBound
Structure”,
and Section 2.3.25, “The NdbRecord
Interface”, for more information.
Class diagram.
This diagram shows all the public members of the
NdbIndexScanOperation
class:
For more information about the use of
NdbIndexScanOperation
, see
Section 1.3.2.3.2, “Scan Operations”, and
Section 1.3.2.3.3, “Using Scans to Update or Delete Rows”