2.3.34 The ScanOptions Structure

Parent class.  NdbScanOperation

Description.  This data structure is used to pass options to the NdbRecord-based scanTable() and scanIndex() methods of the NdbTransaction class. Each option type is marked as present by setting the corresponding bit in the optionsPresent field. Only the option types marked in the optionsPresent field need have sensible data.

All data is copied out of the ScanOptions structure (and any subtended structures) at operation definition time. If no options are required, then NULL may be passed as the ScanOptions pointer.

Members.  The makeup of this structure is shown here:

NdbScanOperation::ScanOptions structure

The individual members are described in more detail in the following table:

NameTypeDescription
optionsPresentUint64Which options are present.
[...]Type:
  • SO_SCANFLAGS: 0x01

  • SO_PARALLEL: 0x02

  • SO_BATCH: 0x04

  • SO_GETVALUE: 0x08

  • SO_PARTITION_ID: 0x10

  • SO_INTERPRETED: 0x20

  • SO_CUSTOMDATA: 0x40

  • SO_PARTINFO: 0x80

Type of options.
scan_flagsUint32Flags controlling scan behavior; see Section 2.3.28.1, “The NdbScanOperation::ScanFlag Type”, for more information.
parallelUint32Scan parallelism; 0 (the default) sets maximum parallelism.
batchUint32Batch size for transfers from data nodes to API nodes; 0 (the default) enables this to be selected automatically.
extraGetValuesGetValueSpecExtra values to be read for each row matching the sdcan criteria.
numExtraGetValuesUint32Number of extra values to be read.
partitionIdUint32Limit the scan to the partition having this ID; alternatively, you can supply an PartitionSpec here. For index scans, partitioning information can be supplied for each range.
interpretedCodeNdbInterpretedCodeInterpeted code to execute as part of the scan.
customDatavoid*Data pointer to associate with this scan operation.
partitionInfoPartitionSpecPartition information for bounding this scan.
sizeOfPartInfoUint32Size of the bounding partition information.

For more information, see Section 2.3.26, “The NdbRecord Interface”.