Struct K2vClient 

pub struct K2vClient { /* private fields */ }

Client used to query a K2V server.

Implementations

impl K2vClient

pub fn new(config: K2vClientConfig) -> Result<Self, Error>

Create a new K2V client.

pub async fn read_item( &self, partition_key: &str, sort_key: &str, ) -> Result<CausalValue, Error>

Perform a ReadItem request, reading the value(s) stored for a single pk+sk.

pub async fn poll_item( &self, partition_key: &str, sort_key: &str, causality: CausalityToken, timeout: Option<Duration>, ) -> Result<Option<CausalValue>, Error>

Perform a PollItem request, waiting for the value(s) stored for a single pk+sk to be updated.

pub async fn poll_range( &self, partition_key: &str, filter: Option<PollRangeFilter<'_>>, seen_marker: Option<&str>, timeout: Option<Duration>, ) -> Result<Option<(BTreeMap<String, CausalValue>, String)>, Error>

Perform a PollRange request, waiting for any change in a given range of keys to occur

pub async fn insert_item( &self, partition_key: &str, sort_key: &str, value: Vec<u8>, causality: Option<CausalityToken>, ) -> Result<(), Error>

Perform an InsertItem request, inserting a value for a single pk+sk.

pub async fn delete_item( &self, partition_key: &str, sort_key: &str, causality: CausalityToken, ) -> Result<(), Error>

Perform a DeleteItem request, deleting the value(s) stored for a single pk+sk.

pub async fn read_index( &self, filter: Filter<'_>, ) -> Result<PaginatedRange<PartitionInfo>, Error>

Perform a ReadIndex request, listing partition key which have at least one associated sort key, and which matches the filter.

pub async fn insert_batch( &self, operations: &[BatchInsertOp<'_>], ) -> Result<(), Error>

Perform an InsertBatch request, inserting multiple values at once. Note: this operation is not atomic: it is possible for some sub-operations to fails and others to success. In that case, failure is reported.

pub async fn read_batch( &self, operations: &[BatchReadOp<'_>], ) -> Result<Vec<PaginatedRange<CausalValue>>, Error>

Perform a ReadBatch request, reading multiple values or range of values at once.

pub async fn delete_batch( &self, operations: &[BatchDeleteOp<'_>], ) -> Result<Vec<u64>, Error>

Perform a DeleteBatch request, deleting mutiple values or range of values at once, without providing causality information.