Struct QueryOptions 

#[non_exhaustive]
pub struct QueryOptions {

    pub args: Option<Vec<Value>>,
    pub atr_collection: Option<String>,
    pub auto_execute: Option<bool>,
    pub client_context_id: Option<String>,
    pub compression: Option<Compression>,
    pub controls: Option<bool>,
    pub creds: Option<Vec<CredsJson>>,
    pub durability_level: Option<DurabilityLevel>,
    pub encoded_plan: Option<String>,
    pub encoding: Option<Encoding>,
    pub format: Option<Format>,
    pub kv_timeout: Option<Duration>,
    pub max_parallelism: Option<u32>,
    pub memory_quota: Option<u32>,
    pub metrics: Option<bool>,
    pub namespace: Option<String>,
    pub num_atrs: Option<u32>,
    pub pipeline_batch: Option<u32>,
    pub pipeline_cap: Option<u32>,
    pub prepared: Option<String>,
    pub preserve_expiry: Option<bool>,
    pub pretty: Option<bool>,
    pub profile: Option<ProfileMode>,
    pub query_context: Option<String>,
    pub read_only: Option<bool>,
    pub scan_cap: Option<u32>,
    pub scan_consistency: Option<ScanConsistency>,
    pub sparse_scan_vector: Option<SparseScanVectors>,
    pub full_scan_vector: Option<FullScanVectors>,
    pub sparse_scan_vectors: Option<HashMap<String, SparseScanVectors>>,
    pub full_scan_vectors: Option<HashMap<String, FullScanVectors>>,
    pub scan_wait: Option<Duration>,
    pub signature: Option<bool>,
    pub statement: Option<String>,
    pub timeout: Option<Duration>,
    pub tx_data: Option<Vec<u8>>,
    pub tx_id: Option<String>,
    pub tx_implicit: Option<bool>,
    pub tx_stmt_num: Option<u32>,
    pub tx_timeout: Option<Duration>,
    pub use_cbo: Option<bool>,
    pub use_fts: Option<bool>,
    pub use_replica: Option<ReplicaLevel>,
    pub named_args: Option<HashMap<String, Value>>,
    pub raw: Option<HashMap<String, Value>>,
    pub on_behalf_of: Option<OnBehalfOfInfo>,
    pub endpoint: Option<String>,
    pub retry_strategy: Arc<dyn RetryStrategy>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

args: Option<Vec<Value>>

atr_collection: Option<String>

auto_execute: Option<bool>

client_context_id: Option<String>

compression: Option<Compression>

controls: Option<bool>

creds: Option<Vec<CredsJson>>

durability_level: Option<DurabilityLevel>

encoded_plan: Option<String>

encoding: Option<Encoding>

format: Option<Format>

kv_timeout: Option<Duration>

max_parallelism: Option<u32>

memory_quota: Option<u32>

metrics: Option<bool>

namespace: Option<String>

num_atrs: Option<u32>

pipeline_batch: Option<u32>

pipeline_cap: Option<u32>

prepared: Option<String>

preserve_expiry: Option<bool>

pretty: Option<bool>

profile: Option<ProfileMode>

query_context: Option<String>

read_only: Option<bool>

scan_cap: Option<u32>

scan_consistency: Option<ScanConsistency>

sparse_scan_vector: Option<SparseScanVectors>

full_scan_vector: Option<FullScanVectors>

sparse_scan_vectors: Option<HashMap<String, SparseScanVectors>>

full_scan_vectors: Option<HashMap<String, FullScanVectors>>

scan_wait: Option<Duration>

signature: Option<bool>

statement: Option<String>

timeout: Option<Duration>

tx_data: Option<Vec<u8>>

tx_id: Option<String>

tx_implicit: Option<bool>

tx_stmt_num: Option<u32>

tx_timeout: Option<Duration>

use_cbo: Option<bool>

use_fts: Option<bool>

use_replica: Option<ReplicaLevel>

named_args: Option<HashMap<String, Value>>

raw: Option<HashMap<String, Value>>

on_behalf_of: Option<OnBehalfOfInfo>

endpoint: Option<String>

retry_strategy: Arc<dyn RetryStrategy>

Implementations

impl QueryOptions

pub fn new() -> Self

pub fn args(self, args: impl Into<Option<Vec<Value>>>) -> Self

pub fn atr_collection(self, atr_collection: impl Into<Option<String>>) -> Self

pub fn auto_execute(self, auto_execute: impl Into<Option<bool>>) -> Self

pub fn client_context_id( self, client_context_id: impl Into<Option<String>>, ) -> Self

pub fn compression(self, compression: impl Into<Option<Compression>>) -> Self

pub fn controls(self, controls: impl Into<Option<bool>>) -> Self

pub fn creds(self, creds: impl Into<Option<Vec<CredsJson>>>) -> Self

pub fn durability_level( self, durability_level: impl Into<Option<DurabilityLevel>>, ) -> Self

pub fn encoded_plan(self, encoded_plan: impl Into<Option<String>>) -> Self

pub fn encoding(self, encoding: impl Into<Option<Encoding>>) -> Self

pub fn format(self, format: impl Into<Option<Format>>) -> Self

pub fn kv_timeout(self, kv_timeout: impl Into<Option<Duration>>) -> Self

pub fn max_parallelism(self, max_parallelism: impl Into<Option<u32>>) -> Self

pub fn memory_quota(self, memory_quota: impl Into<Option<u32>>) -> Self

pub fn metrics(self, metrics: impl Into<Option<bool>>) -> Self

pub fn namespace(self, namespace: impl Into<Option<String>>) -> Self

pub fn num_atrs(self, num_atrs: impl Into<Option<u32>>) -> Self

pub fn pipeline_batch(self, pipeline_batch: impl Into<Option<u32>>) -> Self

pub fn pipeline_cap(self, pipeline_cap: impl Into<Option<u32>>) -> Self

pub fn prepared(self, prepared: impl Into<Option<String>>) -> Self

pub fn preserve_expiry(self, preserve_expiry: impl Into<Option<bool>>) -> Self

pub fn pretty(self, pretty: impl Into<Option<bool>>) -> Self

pub fn profile(self, profile: impl Into<Option<ProfileMode>>) -> Self

pub fn query_context(self, query_context: impl Into<Option<String>>) -> Self

pub fn read_only(self, read_only: impl Into<Option<bool>>) -> Self

pub fn scan_cap(self, scan_cap: impl Into<Option<u32>>) -> Self

pub fn scan_consistency( self, scan_consistency: impl Into<Option<ScanConsistency>>, ) -> Self

pub fn sparse_scan_vector( self, sparse_scan_vector: impl Into<Option<SparseScanVectors>>, ) -> Self

pub fn full_scan_vector( self, full_scan_vector: impl Into<Option<FullScanVectors>>, ) -> Self

pub fn sparse_scan_vectors( self, sparse_scan_vectors: impl Into<Option<HashMap<String, SparseScanVectors>>>, ) -> Self

pub fn full_scan_vectors( self, full_scan_vectors: impl Into<Option<HashMap<String, FullScanVectors>>>, ) -> Self

pub fn scan_wait(self, scan_wait: impl Into<Option<Duration>>) -> Self

pub fn signature(self, signature: impl Into<Option<bool>>) -> Self

pub fn statement(self, statement: impl Into<Option<String>>) -> Self

pub fn timeout(self, timeout: impl Into<Option<Duration>>) -> Self

pub fn tx_data(self, tx_data: impl Into<Option<Vec<u8>>>) -> Self

pub fn tx_id(self, tx_id: impl Into<Option<String>>) -> Self

pub fn tx_implicit(self, tx_implicit: impl Into<Option<bool>>) -> Self

pub fn tx_stmt_num(self, tx_stmt_num: impl Into<Option<u32>>) -> Self

pub fn tx_timeout(self, tx_timeout: impl Into<Option<Duration>>) -> Self

pub fn use_cbo(self, use_cbo: impl Into<Option<bool>>) -> Self

pub fn use_fts(self, use_fts: impl Into<Option<bool>>) -> Self

pub fn use_replica(self, use_replica: impl Into<Option<ReplicaLevel>>) -> Self

pub fn named_args( self, named_args: impl Into<Option<HashMap<String, Value>>>, ) -> Self

pub fn raw(self, raw: impl Into<Option<HashMap<String, Value>>>) -> Self

pub fn on_behalf_of( self, on_behalf_of: impl Into<Option<OnBehalfOfInfo>>, ) -> Self

pub fn retry_strategy(self, retry_strategy: Arc<dyn RetryStrategy>) -> Self

pub fn endpoint(self, endpoint: impl Into<Option<String>>) -> Self

Trait Implementations

impl Clone for QueryOptions

fn clone(&self) -> QueryOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for QueryOptions

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

Formats the value using the given formatter.

impl Default for QueryOptions

fn default() -> Self

Returns the “default value” for a type.

impl From<QueryOptions> for QueryOptions

fn from(opts: QueryOptions) -> Self

Converts to this type from the input type.