Struct Database 

pub struct Database { /* private fields */ }

RedDB Database Engine

The main entry point for database operations. Thread-safe.

Implementations

impl Database

pub fn open<P>(path: P) -> Result<Database, DatabaseError>

where P: AsRef<Path>,

Open or create a database

pub fn bgwriter_stats(&self) -> Option<BgWriterStatsSnapshot>

Background-writer stats snapshot — None when the writer isn’t running (read-only mode, or spawn skipped). Exposed for tests + introspection.

pub fn open_with_config<P>( path: P, config: DatabaseConfig, ) -> Result<Database, DatabaseError>

where P: AsRef<Path>,

Open or create a database with custom configuration

pub fn begin(&self) -> Result<Transaction, DatabaseError>

Begin a new transaction

pub fn pager(&self) -> &Arc<Pager>

Get a reference to the pager (for advanced operations)

pub fn tx_manager(&self) -> &Arc<TransactionManager>

Get a reference to the transaction manager

pub fn allocate_page(&self, page_type: PageType) -> Result<Page, DatabaseError>

Allocate a new page

pub fn read_page(&self, page_id: u32) -> Result<Page, DatabaseError>

Read a page

pub fn checkpoint(&self) -> Result<CheckpointResult, DatabaseError>

Perform a checkpoint

pub fn maybe_auto_checkpoint( &self, ) -> Result<Option<CheckpointResult>, DatabaseError>

Check if auto-checkpoint is needed and perform it

pub fn increment_page_count(&self, count: u32)

Increment pages-since-checkpoint counter

pub fn sync(&self) -> Result<(), DatabaseError>

Sync all data to disk

pub fn close(self) -> Result<(), DatabaseError>

Close the database

Performs a final checkpoint and syncs all data to disk.

pub fn path(&self) -> &Path

Get database file path

pub fn wal_path(&self) -> &Path

Get WAL file path

pub fn is_read_only(&self) -> bool

Check if database is read-only

pub fn page_count(&self) -> u32

Get page count

pub fn file_size(&self) -> Result<u64, DatabaseError>

Get database file size

pub fn cache_stats(&self) -> CacheStats

Get cache statistics

Trait Implementations

impl Drop for Database

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.