Struct redb::Database

source ·

pub struct Database { /* private fields */ }

Expand description

Opened redb database file

Use Self::begin_read to get a ReadTransaction object that can be used to read from the database Use Self::begin_write to get a WriteTransaction object that can be used to read or write to the database

Multiple reads may be performed concurrently, with each other, and with writes. Only a single write may be in progress at a time.

Examples

Basic usage:

use redb::*;
const TABLE: TableDefinition<u64, u64> = TableDefinition::new("my_data");

let db = Database::create(filename)?;
let write_txn = db.begin_write()?;
{
    let mut table = write_txn.open_table(TABLE)?;
    table.insert(&0, &0)?;
}
write_txn.commit()?;

Implementations§

source §

impl Database

source

pub fn create(path: impl AsRef<Path>) -> Result<Database, DatabaseError>

Opens the specified file as a redb database.

if the file does not exist, or is an empty file, a new database will be initialized in it
if the file is a valid redb database, it will be opened
otherwise this function will return an error

source

pub fn open(path: impl AsRef<Path>) -> Result<Database, DatabaseError>

Opens an existing redb database.

source

pub fn check_integrity(&mut self) -> Result<bool, StorageError>

Check the integrity of the database file, and repair it if possible.

Returns Ok(true) if the database passed integrity checks; Ok(false) if it failed but was repaired, and Err(Corrupted) if the check failed and the file could not be repaired

source

pub fn compact(&mut self) -> Result<bool, CompactionError>

Compacts the database file

Returns true if compaction was performed, and false if no futher compaction was possible

source

pub fn builder() -> Builder

Convenience method for Builder::new

source

pub fn begin_write(&self) -> Result<WriteTransaction<'_>, TransactionError>

Begins a write transaction

Returns a WriteTransaction which may be used to read/write to the database. Only a single write may be in progress at a time. If a write is in progress, this function will block until it completes.

source