Struct fdb::transaction::FdbTransaction

pub struct FdbTransaction { /* private fields */ }

A handle to a FDB transaction.

create_transaction method on FdbDatabase can be used to create a FdbTransaction.

Implementations

impl FdbTransaction

pub fn snapshot(&self) -> FdbReadTransaction

Return a special-purpose, read-only view of the database (FdbReadTransaction). Reads done using snapshot are known as snapshot reads. Snapshot reads selectively relax FDB’s isolation property, reducing transaction conflicts but making reasoning about concurrency harder.

For more information about how to use snapshot reads correctly, see snapshot reads.

pub async unsafe fn run<T, F, Fut>(&self, f: F) -> FdbResult<T> where
    F: FnMut(FdbTransaction) -> Fut,
    Fut: Future<Output = FdbResult<T>>, 

Runs a closure in the context of this FdbTransaction.

Safety

You should not use this API. It exists to support binding tester.

pub async unsafe fn read<T, F, Fut>(&self, f: F) -> FdbResult<T> where
    F: FnMut(FdbTransaction) -> Fut,
    Fut: Future<Output = FdbResult<T>>, 

Runs a closure in the context of FdbReadTransaction, derived from FdbTransaction.

Safety

You should not use this API. It exists to support binding tester.

Trait Implementations

impl Clone for FdbTransaction

fn clone(&self) -> FdbTransaction

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FdbTransaction

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

Formats the value using the given formatter.

impl Drop for FdbTransaction

fn drop(&mut self)

Executes the destructor for this type.

impl ReadTransaction for FdbTransaction

unsafe fn on_error(&self, e: FdbError) -> FdbFutureUnit

Determines whether an error returned by a Transaction or ReadTransaction method is retryable. Waiting on the returned future will return the same error when fatal, or return () for retryable errors.

fn get(&self, key: impl Into<Key>) -> FdbFutureMaybeValue

Gets a value from the database.

fn get_addresses_for_key(&self, key: impl Into<Key>) -> FdbFutureCStringArray

Get a list of public network addresses as CString, one for each of the storage servers responsible for storing Key and its associated value.

fn get_estimated_range_size_bytes(&self, range: Range) -> FdbFutureI64

Gets an estimate for the number of bytes stored in the given range.

fn get_key(&self, selector: KeySelector) -> FdbFutureKey

Returns the key referenced by the specificed KeySelector.

fn get_mapped_range(
    &self,
    begin: KeySelector,
    end: KeySelector,
    mapper: impl Into<Mapper>,
    options: RangeOptions
) -> FdbStreamMappedKeyValue

WARNING: This feature is considered experimental at this time.

fn get_range(
    &self,
    begin: KeySelector,
    end: KeySelector,
    options: RangeOptions
) -> FdbStreamKeyValue

Gets an ordered range of keys and values from the database.

fn get_range_split_points(
    &self,
    begin: impl Into<Key>,
    end: impl Into<Key>,
    chunk_size: i64
) -> FdbFutureKeyArray

Gets a list of keys that can split the given range into (roughly) equally sized chunks based on chunk_size.

unsafe fn get_read_version(&self) -> FdbFutureI64

Gets the version at which the reads for this Transaction or ReadTransaction will access the database.

fn set_option(&self, option: TransactionOption) -> FdbResult<()>

Set options on a Transaction or ReadTransaction

unsafe fn set_read_version(&self, version: i64)

Directly sets the version of the database at which to execute reads.

impl Transaction for FdbTransaction

fn add_read_conflict_key(&self, key: impl Into<Key>) -> FdbResult<()>

Adds a key to the transaction’s read conflict ranges as if you had read the key.

fn add_read_conflict_range(&self, range: Range) -> FdbResult<()>

Adds a range of keys to the transaction’s read conflict ranges as if you had read the range.

fn add_write_conflict_key(&self, key: impl Into<Key>) -> FdbResult<()>

Adds a key to the transaction’s write conflict ranges as if you had written the key.

fn add_write_conflict_range(&self, range: Range) -> FdbResult<()>

Adds a range of keys to the transaction’s write conflict ranges as if you had cleared the range.

unsafe fn cancel(&self)

Cancels the Transaction.

fn clear(&self, key: impl Into<Key>)

Clears a given key from the database.

fn clear_range(&self, range: Range)

Clears a range of keys from the database.

unsafe fn commit(&self) -> FdbFutureUnit

Commit this Transaction.

fn get_approximate_size(&self) -> FdbFutureI64

Returns a future that will contain the approximated size of the commit, which is the summation of mutations, read conflict ranges, and write conflict ranges.

unsafe fn get_committed_version(&self) -> CommittedVersion

Gets the version number at which a successful commit modified the database.

unsafe fn get_versionstamp(&self) -> TransactionVersionstamp

Returns TransactionVersionstamp from which you can get the versionstamp which was used by any versionstamp operations in this transaction.

unsafe fn mutate(&self, optype: MutationType, key: impl Into<Key>, param: Bytes)

An atomic operation is a single database command that carries out several logical steps: reading the value of a key, performing a transformation on that value, and writing the result.

unsafe fn reset(&self)

Reset the Transaction.

fn set(&self, key: impl Into<Key>, value: impl Into<Value>)

Sets the value for a given key.

fn watch(&self, key: impl Into<Key>) -> FdbFutureUnit

Creates a watch that will become ready when it reports a change to the value of the specified key.

impl Send for FdbTransaction

impl Sync for FdbTransaction