Struct aerospike::policy::ScanPolicy

pub struct ScanPolicy {
    pub base_policy: BasePolicy,
    pub scan_percent: u8,
    pub max_concurrent_nodes: usize,
    pub record_queue_size: usize,
    pub fail_on_cluster_change: bool,
    pub socket_timeout: u32,
    pub filter_expression: Option<FilterExpression>,
}

ScanPolicy encapsulates optional parameters used in scan operations.

Fields

base_policy: BasePolicy

Base policy instance

scan_percent: u8

Percent of data to scan. Valid integer range is 1 to 100. Default is 100. This is deprected and won’t be sent to the server.

max_concurrent_nodes: usize

Maximum number of concurrent requests to server nodes at any point in time. If there are 16 nodes in the cluster and max_concurrent_nodes 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. Default (0) is to issue requests to all server nodes in parallel.

record_queue_size: usize

Number of records to place in queue before blocking. Records received from multiple server nodes will be placed in a queue. A separate thread consumes these records in parallel. If the queue is full, the producer threads will block until records are consumed.

fail_on_cluster_change: bool

Terminate scan if cluster is in fluctuating state. This is deprected and won’t be sent to the server.

socket_timeout: u32

Maximum time in milliseconds to wait when polling socket for availability prior to performing an operation on the socket on the server side. Zero means there is no socket timeout. Default: 10,000 ms.

filter_expression: Option<FilterExpression>

Optional Filter Expression

Implementations

impl ScanPolicy

pub fn new() -> Self

Create a new scan policy instance with default parameters.

pub const fn filter_expression(&self) -> &Option<FilterExpression>

Get the current Filter Expression

Trait Implementations

impl Clone for ScanPolicy

fn clone(&self) -> ScanPolicy

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ScanPolicy

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ScanPolicy

fn default() -> Self

Returns the “default value” for a type.