Struct DbOptions 

pub struct DbOptions {

    pub path: PathBuf,
    pub busy_timeout: Duration,
    pub key: Option<Zeroizing<String>>,
    pub raw_key: Option<Zeroizing<[u8; 32]>>,
    pub profile: CacheProfile,
    pub durability: DurabilityProfile,
    pub foreign_keys: bool,
    pub integrity_check_on_open: bool,
    pub journal: JournalSelect,
    pub owner_only: bool,
    pub init: Option<ConnInit>,
    pub journal_env: Option<String>,
    pub per_host_fallback: bool,
}

Fields

path: PathBuf

busy_timeout: Duration

SQLite busy wait, installed before key verification or any bootstrap statement. Default: five seconds.

key: Option<Zeroizing<String>>

SQLCipher passphrase-style key (base64-ish charset). See also DbOptions::raw_key.

raw_key: Option<Zeroizing<[u8; 32]>>

SQLCipher raw 256-bit key, applied as x'<hex>' (no KDF). Takes precedence over key.

profile: CacheProfile

durability: DurabilityProfile

foreign_keys: bool

integrity_check_on_open: bool

journal: JournalSelect

owner_only: bool

Narrow the database and its sidecars to owner-only (0600) on unix. Default on.

init: Option<ConnInit>

journal_env: Option<String>

The app’s own kill-switch variable (e.g. CODERIGHT_SQLITE_JOURNAL_MODE), checked before JOURNAL_ENV.

per_host_fallback: bool

When a rollback journal is in force (network mount, kill switch, or WAL refused), open the per-host sibling per_host_path instead of the requested file, so hosts sharing a network directory never share one rollback-journaled database. The requested file is not created. Default off.

Implementations

impl DbOptions

pub fn restore_from(&self, backup_path: impl AsRef<Path>) -> Result<()>

Validate the backup first, then open the existing live database without bootstrap and restore it. Neither missing backup nor missing live DB is created. The backup must use the same SQLCipher key as these options.

impl DbOptions

pub fn open_writer_migrated( &self, migrations: &[Migration], options: &MigrateOptions, ) -> Result<(Connection, MigrationReport)>

Open the writer and bring the schema up to date (see migrate); the pre-migration backup is keyed like the database itself.

impl DbOptions

pub fn open_writer_with_key_candidates( &self, candidates: &[Zeroizing<String>], ) -> Result<(Connection, usize)>

Try each passphrase in order; the first that decrypts opens the writer.

pub fn open_writer_recovering( &self, policy: RecoveryPolicy, ) -> Result<OpenOutcome>

Open the writer; if the file is unreadable and the policy allows it, quarantine it and open a fresh database at the same path.

impl DbOptions

pub fn new(path: impl Into<PathBuf>) -> Self

pub fn with_journal_env(self, name: impl Into<String>) -> Self

pub fn with_per_host_fallback(self, on: bool) -> Self

pub fn effective_path(&self) -> PathBuf

The file connections actually open: the requested path, or its per-host sibling when Self::per_host_fallback applies (a rollback journal is in force, or a writer already fell back there).

pub fn with_passphrase(self, key: impl Into<String>) -> Self

pub fn with_raw_key(self, key: [u8; 32]) -> Self

pub fn is_keyed(&self) -> bool

pub fn open_writer(&self) -> Result<Connection>

pub fn open_reader(&self) -> Result<Connection>

pub fn open_read_only(&self) -> Result<Connection>

Open exactly path read-only, without creating it or running mutating bootstrap. URI parameters are passed to SQLite unchanged. Journal fallback, permissions, init, optimization, and migrations are skipped; key and timeout still apply.

pub fn open_existing_writer(&self) -> Result<Connection>

Open exactly path read-write without CREATE or mutating bootstrap. Uses the same minimal setup as Self::open_read_only.

pub fn open_in_memory(&self) -> Result<Connection>

Open a private, ephemeral database. path, filesystem permissions, journal selection/fallback, and mmap are ignored; other bootstrap options still apply.

pub fn open_read_pool(&self, cap: usize) -> Result<ReadPool>

Trait Implementations

impl Clone for DbOptions

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.