1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83
// Copyright 2015-2020 Aerospike, Inc.
//
// Portions may be licensed to Aerospike, Inc. under one or more contributor
// license agreements.
//
// Licensed under the Apache License, Version 2.0 (the "License"); you may not
// use this file except in compliance with the License. You may obtain a copy of
// the License at http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
// WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
// License for the specific language governing permissions and limitations under
// the License.
use crate::expressions::FilterExpression;
use crate::policy::{BasePolicy, PolicyLike};
/// `ScanPolicy` encapsulates optional parameters used in scan operations.
#[derive(Debug, Clone)]
pub struct ScanPolicy {
/// Base policy instance
pub base_policy: BasePolicy,
/// 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.
pub scan_percent: u8,
/// 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.
pub max_concurrent_nodes: 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.
pub record_queue_size: usize,
/// Terminate scan if cluster is in fluctuating state.
/// This is deprected and won't be sent to the server.
pub fail_on_cluster_change: bool,
/// 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.
pub socket_timeout: u32,
/// Optional Filter Expression
pub filter_expression: Option<FilterExpression>,
}
impl ScanPolicy {
/// Create a new scan policy instance with default parameters.
pub fn new() -> Self {
ScanPolicy::default()
}
/// Get the current Filter Expression
pub const fn filter_expression(&self) -> &Option<FilterExpression> {
&self.filter_expression
}
}
impl Default for ScanPolicy {
fn default() -> Self {
ScanPolicy {
base_policy: BasePolicy::default(),
scan_percent: 100,
max_concurrent_nodes: 0,
record_queue_size: 1024,
fail_on_cluster_change: true,
socket_timeout: 10000,
filter_expression: None,
}
}
}
impl PolicyLike for ScanPolicy {
fn base(&self) -> &BasePolicy {
&self.base_policy
}
}