Struct DatabaseTransaction

pub struct DatabaseTransaction<'tx, Cap = NonCommittable> {
    tx: Box<dyn IDatabaseTransaction + 'tx>,
    decoders: ModuleDecoderRegistry,
    commit_tracker: MaybeRef<'tx, CommitTracker>,
    on_commit_hooks: MaybeRef<'tx, Vec<Box<dyn FnOnce() + Send>>>,
    capability: PhantomData<Cap>,
}

A high level database transaction handle

Cap is a session type

Fields

tx: Box<dyn IDatabaseTransaction + 'tx>

decoders: ModuleDecoderRegistry

commit_tracker: MaybeRef<'tx, CommitTracker>

on_commit_hooks: MaybeRef<'tx, Vec<Box<dyn FnOnce() + Send>>>

capability: PhantomData<Cap>

Implementations

impl<'tx, Cap> DatabaseTransaction<'tx, Cap>

pub fn into_nc(self) -> DatabaseTransaction<'tx, NonCommittable>

Convert into a non-committable version

pub fn to_ref_nc<'s, 'a>( &'s mut self, ) -> DatabaseTransaction<'a, NonCommittable>

where 's: 'a,

Get a reference to a non-committeable version

pub fn with_prefix<'a: 'tx>( self, prefix: Vec<u8>, ) -> DatabaseTransaction<'a, Cap>

where 'tx: 'a,

Get DatabaseTransaction isolated to a prefix

pub fn with_prefix_module_id<'a: 'tx>( self, module_instance_id: ModuleInstanceId, ) -> (DatabaseTransaction<'a, Cap>, GlobalDBTxAccessToken)

where 'tx: 'a,

Get DatabaseTransaction isolated to a prefix of a given module_instance_id, allowing the module to access global_dbtx with the right access token.

pub fn to_ref<'s, 'a>(&'s mut self) -> DatabaseTransaction<'a, Cap>

where 's: 'a,

Get DatabaseTransaction to self

pub fn to_ref_with_prefix<'a>( &'a mut self, prefix: Vec<u8>, ) -> DatabaseTransaction<'a, Cap>

where 'tx: 'a,

Get DatabaseTransaction isolated to a prefix of self

pub fn to_ref_with_prefix_module_id<'a>( &'a mut self, module_instance_id: ModuleInstanceId, ) -> (DatabaseTransaction<'a, Cap>, GlobalDBTxAccessToken)

where 'tx: 'a,

pub fn is_global(&self) -> bool

Is this Database a global, unpartitioned Database

pub fn ensure_global(&self) -> Result<()>

Err if Self::is_global is not true

pub fn ensure_isolated(&self) -> Result<()>

Err if Self::is_global is true

pub fn ignore_uncommitted(&mut self) -> &mut Self

Cancel the tx to avoid debugging warnings about uncommitted writes

pub fn warn_uncommitted(&mut self) -> &mut Self

Create warnings about uncommitted writes

pub fn on_commit(&mut self, f: impl FnOnce() + 'static + Send)

Register a hook that will be run after commit succeeds.

pub fn global_dbtx<'a>( &'a mut self, access_token: GlobalDBTxAccessToken, ) -> DatabaseTransaction<'a, Cap>

where 'tx: 'a,

impl<'tx> DatabaseTransaction<'tx, Committable>

pub fn new( dbtx: Box<dyn IDatabaseTransaction + 'tx>, decoders: ModuleDecoderRegistry, ) -> Self

pub async fn commit_tx_result(self) -> Result<()>

pub async fn commit_tx(self)

Trait Implementations

impl<'tx, Cap> Debug for DatabaseTransaction<'tx, Cap>

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

Formats the value using the given formatter.

impl<'a> IDatabaseTransactionOps for DatabaseTransaction<'a, Committable>

fn set_tx_savepoint<'life0, 'async_trait>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Create a savepoint during the transaction that can be rolled back to using rollback_tx_to_savepoint. Rolling back to the savepoint will atomically remove the writes that were applied since the savepoint was created.

fn rollback_tx_to_savepoint<'life0, 'async_trait>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

impl<'a, Cap> IDatabaseTransactionOpsCore for DatabaseTransaction<'a, Cap>

where Cap: Send,

fn raw_insert_bytes<'life0, 'life1, 'life2, 'async_trait>( &'life0 mut self, key: &'life1 [u8], value: &'life2 [u8], ) -> Pin<Box<dyn Future<Output = Result<Option<Vec<u8>>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Insert entry

fn raw_get_bytes<'life0, 'life1, 'async_trait>( &'life0 mut self, key: &'life1 [u8], ) -> Pin<Box<dyn Future<Output = Result<Option<Vec<u8>>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Get key value

fn raw_remove_entry<'life0, 'life1, 'async_trait>( &'life0 mut self, key: &'life1 [u8], ) -> Pin<Box<dyn Future<Output = Result<Option<Vec<u8>>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Remove entry by key

fn raw_find_by_range<'life0, 'life1, 'async_trait>( &'life0 mut self, key_range: Range<&'life1 [u8]>, ) -> Pin<Box<dyn Future<Output = Result<PrefixStream<'_>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Returns an stream of key-value pairs with keys within a range, sorted by key. Range is an (half-open) range bounded inclusively below and exclusively above.

fn raw_find_by_prefix<'life0, 'life1, 'async_trait>( &'life0 mut self, key_prefix: &'life1 [u8], ) -> Pin<Box<dyn Future<Output = Result<PrefixStream<'_>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Returns an stream of key-value pairs with keys that start with key_prefix, sorted by key.

fn raw_find_by_prefix_sorted_descending<'life0, 'life1, 'async_trait>( &'life0 mut self, key_prefix: &'life1 [u8], ) -> Pin<Box<dyn Future<Output = Result<PrefixStream<'_>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Same as Self::raw_find_by_prefix but the order is descending by key.

fn raw_remove_by_prefix<'life0, 'life1, 'async_trait>( &'life0 mut self, key_prefix: &'life1 [u8], ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Delete keys matching prefix

impl<'tx, Cap> WithDecoders for DatabaseTransaction<'tx, Cap>

fn decoders(&self) -> &ModuleDecoderRegistry