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 savepoint(&self) -> Result<Savepoint, Error>

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

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

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

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

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

Open the given table

The table will be created if it does not exist

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

Open the given table

The table will be created if it does not exist

pub fn delete_table<K: RedbKey + ?Sized, V: RedbValue + ?Sized>(
    &self,
    definition: TableDefinition<'_, K, V>
) -> Result<bool, Error>

Delete the given table

Returns a bool indicating whether the table existed

pub fn delete_multimap_table<K: RedbKey + ?Sized, V: RedbKey + ?Sized>(
    &self,
    definition: MultimapTableDefinition<'_, K, V>
) -> Result<bool, Error>

Delete the given table

Returns a bool indicating whether the table existed

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

List all the tables

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

List all the multimap tables

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

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<(), Error>

Abort the transaction

All writes performed in this transaction will be rolled back

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

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.