Struct surrealkv::Transaction

pub struct Transaction { /* private fields */ }

Transaction is a struct representing a transaction in a database.

Implementations

impl Transaction

pub fn new(core: Arc<Core>, mode: Mode) -> Result<Self>

Prepare a new transaction in the given mode.

pub fn mode(&self) -> Mode

Returns the transaction mode.

pub fn set_durability(&mut self, durability: Durability)

Sets the durability level of the transaction.

pub fn set(&mut self, key: &[u8], value: &[u8]) -> Result<()>

Adds a key-value pair to the store.

pub fn set_at_ts(&mut self, key: &[u8], value: &[u8], ts: u64) -> Result<()>

Adds a key-value pair to the store with the given timestamp.

pub fn delete(&mut self, key: &[u8]) -> Result<()>

pub fn clear(&mut self, key: &[u8]) -> Result<()>

Clear the key but not delete it. This is a soft delete.

pub fn get(&self, key: &[u8]) -> Result<Option<Vec<u8>>>

Gets a value for a key if it exists.

pub fn scan<'b, R>( &'b self, range: R, limit: Option<usize>, ) -> Result<Vec<(Vec<u8>, Vec<u8>, u64, u64)>>

where R: RangeBounds<&'b [u8]>,

Scans a range of keys and returns a vector of tuples containing the value, version, and timestamp for each key.

pub async fn commit(&mut self) -> Result<()>

Commits the transaction, by writing all pending entries to the store.

pub fn rollback(&mut self)

Rolls back the transaction by removing all updated entries.

pub fn set_savepoint(&mut self) -> Result<()>

After calling this method the subsequent modifications within this transaction can be rolled back by calling rollback_to_savepoint.

This method is stackable and can be called multiple times with the corresponding calls to rollback_to_savepoint.

pub fn rollback_to_savepoint(&mut self) -> Result<()>

Rollback the state of the transaction to the latest savepoint set by calling set_savepoint.

impl Transaction

Implement Versioned APIs for read-only transactions.

pub fn get_at_ts(&self, key: &[u8], ts: u64) -> Result<Option<Vec<u8>>>

Returns the value associated with the key at the given timestamp.

pub fn get_history(&self, key: &[u8]) -> Result<Vec<(Vec<u8>, u64)>>

Returns all the versioned values and timestamps associated with the key.

pub fn scan_at_ts<'b, R>( &'b self, range: R, ts: u64, limit: Option<usize>, ) -> Result<Vec<(Vec<u8>, Vec<u8>)>>

where R: RangeBounds<&'b [u8]>,

Returns key-value pairs within the specified range, at the given timestamp.

pub fn keys_at_ts<'b, R>(&'b self, range: R, ts: u64) -> Result<Vec<Vec<u8>>>

where R: RangeBounds<&'b [u8]>,

Returns keys within the specified range, at the given timestamp.

pub fn get_value_by_query( &self, key: &VariableSizeKey, query_type: QueryType, ) -> Result<(Bytes, u64, u64)>

Returns the value associated with the key at the given timestamp. The query type specifies the type of query to perform. The query type can be LatestByVersion, LatestByTs, LastLessThanTs, LastLessOrEqualTs, FirstGreaterOrEqualTs or FirstGreaterThanTs.

Trait Implementations

impl Drop for Transaction

fn drop(&mut self)

Executes the destructor for this type.