ScanPolicy FieldsAerospike
The ScanPolicy type exposes the following members.
Fields

  NameDescription
Public fieldconcurrentNodes
Issue scan requests in parallel or serially.
Public fieldconsistencyLevel
How replicas should be consulted in a read operation to provide the desired consistency guarantee.

Default: CONSISTENCY_ONE

(Inherited from Policy.)
Public fieldfailOnClusterChange
Terminate scan if cluster in fluctuating state.
Public fieldincludeBinData
Indicates if bin data is retrieved. If false, only record digests are retrieved.
Public fieldincludeLDT
Include large data type bin values in addition to large data type bin names. If false, LDT bin names will be returned, but LDT bin values will be empty. If true, LDT bin names and the entire LDT bin values will be returned. Warning: LDT values may consume huge of amounts of memory depending on LDT size. Default: false
Public fieldmaxConcurrentNodes
Maximum number of concurrent requests to server nodes at any point in time. If there are 16 nodes in the cluster and maxConcurrentNodes is 8, then scan requests will be made to 8 nodes in parallel. When a scan completes, a new scan request will be issued until all 16 nodes have been scanned.

This field is only relevant when concurrentNodes is true. Default (0) is to issue requests to all server nodes in parallel.

Public fieldmaxRetries
Maximum number of retries before aborting the current transaction. A retry may be attempted when there is a network error. If maxRetries is exceeded, the abort will occur even if the timeout has not yet been exceeded.

Default: 1

(Inherited from Policy.)
Public fieldpriority
Priority of request relative to other transactions. Currently, only used for scans.
(Inherited from Policy.)
Public fieldreplica
Send read commands to the node containing the key's partition replica type. Write commands are not affected by this setting, because all writes are directed to the node containing the key's master partition.

Default: MASTER

(Inherited from Policy.)
Public fieldretryOnTimeout
Should the client retry a command if the timeout is reached.

If false, throw timeout exception when the timeout has been reached. Note that retries can still occur if a command fails on a network error before the timeout has been reached.

If true, retry command with same timeout when the timeout has been reached. The maximum number of retries is defined by maxRetries.

Default: false
(Inherited from Policy.)
Public fieldscanPercent
Percent of data to scan. Valid integer range is 1 to 100. Default is 100.
Public fieldsendKey
Send user defined key in addition to hash digest on both reads and writes.

Default: false (do not send the user defined key)

(Inherited from Policy.)
Public fieldsleepBetweenRetries
Milliseconds to sleep between retries. Do not sleep at all if zero. Used by synchronous commands only.

Default: 500ms

(Inherited from Policy.)
Public fieldtimeout
Total transaction timeout in milliseconds for both client and server. The timeout is tracked on the client and also sent to the server along with the transaction in the wire protocol. The client will most likely timeout first, but the server has the capability to timeout the transaction as well.

The timeout is also used as a socket timeout. Default: 0 (no timeout).

(Inherited from Policy.)
Back to Top
See Also