Struct Database 

pub struct Database { /* private fields */ }

An open Citadel database (Send + Sync).

Exclusively locks the database file for its lifetime.

Implementations

impl Database

pub fn begin_read(&self) -> ReadTxn<'_>

Begin a read-only transaction with snapshot isolation.

pub fn begin_write(&self) -> Result<WriteTxn<'_>>

Begin a read-write transaction. Only one can be active at a time.

pub fn stats(&self) -> DbStats

Get database statistics from the current commit slot.

pub fn data_path(&self) -> &Path

Path to the data file.

pub fn key_path(&self) -> &Path

Path to the key file.

pub fn reader_count(&self) -> usize

Number of currently active readers.

pub fn change_passphrase( &self, old_passphrase: &[u8], new_passphrase: &[u8], ) -> Result<()>

Change the database passphrase (re-wraps REK, no page re-encryption).

pub fn integrity_check(&self) -> Result<IntegrityReport>

Run an integrity check on the database.

pub fn backup(&self, dest_path: &Path) -> Result<()>

Create a hot backup via MVCC snapshot. Also copies the key file.

pub fn export_key_backup( &self, db_passphrase: &[u8], backup_passphrase: &[u8], dest_path: &Path, ) -> Result<()>

Export an encrypted key backup for disaster recovery.

Requires the current database passphrase. The backup can later restore access via restore_key_from_backup if the database passphrase is lost.

pub fn restore_key_from_backup( backup_path: &Path, backup_passphrase: &[u8], new_db_passphrase: &[u8], db_path: &Path, ) -> Result<()>

Restore a key file from an encrypted backup (static — no Database needed).

Unwraps the REK using backup_passphrase, then creates a new key file protected by new_db_passphrase.

pub fn compact(&self, dest_path: &Path) -> Result<()>

Compact the database into a new file. Also copies the key file.

impl Database

pub fn audit_log_path(&self) -> Option<PathBuf>

Path to the audit log file, if audit logging is enabled.

pub fn verify_audit_log(&self) -> Result<AuditVerifyResult>

Verify the audit log’s HMAC chain integrity.

impl Database

pub fn node_id(&self) -> Result<NodeId>

Get or create a persistent NodeId for this database.

pub fn sync_to(&self, addr: &str, sync_key: &SyncKey) -> Result<SyncOutcome>

Push local named tables to a remote peer.

pub fn handle_sync( &self, stream: TcpStream, sync_key: &SyncKey, ) -> Result<SyncOutcome>

Handle an incoming sync session from a remote peer.

Trait Implementations

impl Debug for Database

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Drop for Database

Available on crate feature audit-log only.

fn drop(&mut self)

Executes the destructor for this type.

impl Send for Database

impl Sync for Database