Struct DB

pub struct DB { /* private fields */ }

Represents the main database instance.

DB is the entry point for all database interactions. It handles the underlying storage and provides methods to create read-only or read-write transactions.

Implementations

impl DB

pub fn open_or_create<P: AsRef<Path>>(path: P) -> Result<Self>

Opens an existing database file or creates a new one if it doesn’t exist. Uses default settings. If you need customization, use DBBuilder::new instead.

Parameters

• path: A path to the database file.

Errors

Returns TxnError if the database file cannot be opened or created, or if there’s an issue initializing the memory map.

pub fn r_txn(&self) -> RTxn<'_, '_>

Begins a new read-only transaction.

Read-only transactions allow for concurrent reads without blocking other readers or writers.

Returns

A RTxn instance for performing read operations.

pub fn rw_txn(&self) -> RWTxn<'_, '_>

Begins a new read-write transaction.

Read-write transactions provide exclusive write access. Changes made within this transaction are isolated until commit is called.

Returns

A RWTxn instance for performing read and write operations.

Trait Implementations

impl Clone for DB

fn clone(&self) -> DB

Returns a copy of the value.

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

Performs copy-assignment from source.