Struct Database 

pub struct Database {
    pub(crate) maps: BTreeMap<&'static str, Arc<Map>>,
    pub engine: Arc<Engine>,
    pub(crate) _ctx: Arc<Context>,
}

An open Tuwunel database and its configured maps.

Each instance owns maps created by one RocksDB engine. Typed accessors preserve that ownership relationship for individual reads and atomic transactions.

Fields

maps: BTreeMap<&'static str, Arc<Map>>

engine: Arc<Engine>

The RocksDB engine backing every map in this database.

Callers use the engine for database-wide operations such as backups and memory reporting. Maps and transactions must remain associated with this same engine.

_ctx: Arc<Context>

Implementations

impl Database

pub fn cork(&self) -> Cork

Open a coalescing window without forcing a flush when it closes.

Per-write WAL flushing is suppressed for the guard’s lifetime; the buffered records are left for the next uncorked write (or RocksDB) to flush. Use when the burst need not be durable at any particular point.

pub fn cork_and_flush(&self) -> Cork

Open a coalescing window that flushes the WAL to the OS on drop.

Behaves like cork, but the accumulated WAL is pushed to the OS (without an fsync) as the guard drops, bounding the buffered window to the burst.

pub fn cork_and_sync(&self) -> Cork

Open a coalescing window that syncs the WAL to disk on drop.

Behaves like cork_and_flush, but the WAL is fsynced as the guard drops, so the burst is durable against power loss once the guard has gone.

impl Database

pub async fn open(server: &Arc<Server>) -> Result<Arc<Self>>

Loads an existing database or creates a new one.

The configured map catalog is opened after the engine and indexed by column family identity. The returned shared handle keeps the engine context alive for its full lifetime.

pub fn txn(&self) -> Txn

Creates an empty transaction for this database.

The transaction is bound to this database’s engine and accepts writes only for maps owned by that engine. Queued operations remain unapplied until the transaction is executed.

pub fn get(&self, name: &str) -> Result<&Arc<Map>>

Retrieves a configured map by name.

The returned map belongs to this database’s engine. An unknown name produces a not-found database error.

pub fn open_cf(&self, name: &'static str) -> Result<Option<Arc<Map>>>

Opens an existing column family outside the configured map catalog.

Migration readers use this for foreign database families that are not described by MAPS. An absent family returns None without creating it.

pub fn iter( &self, ) -> impl Iterator<Item = (&&'static str, &Arc<Map>)> + Send + '_

Iterates over configured map names and handles.

Entries follow the catalog’s sorted map order. Every yielded handle belongs to this database’s engine.

pub fn keys(&self) -> impl Iterator<Item = &&'static str> + Send + '_

Iterates over the configured map names.

Names follow the catalog’s sorted map order. The iterator borrows this database for the duration of the traversal.

pub fn is_read_only(&self) -> bool

Reports whether the engine rejects writes.

Writes are rejected when the database is opened read-only or as a secondary instance. The value applies to every map owned by this database.

pub fn is_secondary(&self) -> bool

Reports whether this database is a secondary RocksDB instance.

A secondary instance follows another database and does not act as its primary writer. The value applies to every map owned by this database.

Trait Implementations

impl Index<&str> for Database

fn index(&self, name: &str) -> &Self::Output

Retrieves a configured map by name.

Indexing offers concise access when the map name is a static database invariant. Use Database::get when absence should be handled as an error.

Panics

Panics if this database has no configured map with the requested name.

type Output = Arc<Map>

The returned type after indexing.