Struct redb::WriteTransaction

pub struct WriteTransaction<'db> { /* private fields */ }

A read/write transaction

Only a single WriteTransaction may exist at a time

Implementations

impl<'db> WriteTransaction<'db>

pub fn persistent_savepoint(&self) -> Result<u64, SavepointError>

Creates a snapshot of the current database state, which can be used to rollback the database. This savepoint will exist until it is deleted with [delete_savepoint()].

Note that while a savepoint exists, pages that become unused after it was created are not freed. Therefore, the lifetime of a savepoint should be minimized.

Returns [SavepointError::InvalidSavepoint], if the transaction is “dirty” (any tables have been opened) or if the transaction’s durability is less than [Durability::Immediate]

pub fn get_persistent_savepoint( &self, id: u64 ) -> Result<Savepoint, SavepointError>

Get a persistent savepoint given its id

pub fn delete_persistent_savepoint( &self, id: u64 ) -> Result<bool, SavepointError>

Delete the given persistent savepoint.

Note that if the transaction is abort()’ed this deletion will be rolled back.

Returns true if the savepoint existed Returns [SavepointError::InvalidSavepoint] if the transaction’s durability is less than [Durability::Immediate]

pub fn list_persistent_savepoints( &self ) -> Result<impl Iterator<Item = u64>, StorageError>

List all persistent savepoints

pub fn ephemeral_savepoint(&self) -> Result<Savepoint, SavepointError>

Creates a snapshot of the current database state, which can be used to rollback the database

This savepoint will be freed as soon as the returned [Savepoint] is dropped.

Returns [SavepointError::InvalidSavepoint], if the transaction is “dirty” (any tables have been opened)

pub fn restore_savepoint( &mut self, savepoint: &Savepoint ) -> Result<(), SavepointError>

Restore the state of the database to the given Savepoint

Calling this method invalidates all Savepoints created after savepoint

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

Set the desired durability level for writes made in this transaction Defaults to Durability::Immediate

Will panic if the durability is reduced below [Durability::Immediate] after a persistent savepoint has been created or deleted.

pub fn open_table<'txn, K: RedbKey + 'static, V: RedbValue + 'static>( &'txn self, definition: TableDefinition<'_, K, V> ) -> Result<Table<'db, 'txn, K, V>, TableError>

Open the given table

The table will be created if it does not exist

pub fn open_multimap_table<'txn, K: RedbKey + 'static, V: RedbKey + 'static>( &'txn self, definition: MultimapTableDefinition<'_, K, V> ) -> Result<MultimapTable<'db, 'txn, K, V>, TableError>

Open the given table

The table will be created if it does not exist

pub fn delete_table( &self, definition: impl TableHandle ) -> Result<bool, TableError>

Delete the given table

Returns a bool indicating whether the table existed

pub fn delete_multimap_table( &self, definition: impl MultimapTableHandle ) -> Result<bool, TableError>

Delete the given table

Returns a bool indicating whether the table existed

pub fn list_tables( &self ) -> Result<impl Iterator<Item = UntypedTableHandle> + '_, StorageError>

List all the tables

pub fn list_multimap_tables( &self ) -> Result<impl Iterator<Item = UntypedMultimapTableHandle> + '_, StorageError>

List all the multimap tables

pub fn commit(self) -> Result<(), CommitError>

Commit the transaction

All writes performed in this transaction will be visible to future transactions, and are durable as consistent with the Durability level set by Self::set_durability

pub fn abort(self) -> Result<(), StorageError>

Abort the transaction

All writes performed in this transaction will be rolled back

pub fn stats(&self) -> Result<DatabaseStats, StorageError>

Retrieves information about storage usage in the database

Trait Implementations

impl<'a> Drop for WriteTransaction<'a>

fn drop(&mut self)

Executes the destructor for this type.