Struct DatabaseBuilder 

pub struct DatabaseBuilder { /* private fields */ }

Choices needed to open the database part of a store.

Implementations

impl DatabaseBuilder

pub fn new(directory: StoreDir) -> Self

Begin an open using a directory supplied by the store layout.

pub fn refuse_close(self) -> Self

Have SQLite refuse to close the opened store’s writer.

pub fn subscribe_progress(&self) -> ProgressWatch<OpenStep>

The steps a writable open reports as it runs them, each with how much of it is done (§4). A read-only open runs none.

pub fn synced_tables(self, tables: Vec<SyncedTable>) -> Self

The tables that sync, described at the newest app schema version.

pub fn namespaces(self, namespaces: Vec<Namespace>) -> Self

The file namespaces, each with its kind and cache budget (§17.1).

pub fn migrations(self, migrations: Vec<Migration>) -> Self

The complete app migration sequence, numbered from one.

pub fn loading_store(self) -> Self

Open an installation that loads its store from storage next, for a join, restore or reset: its breaking migrations make no migration write, since the device isn’t registered yet and the load replaces what they changed (§18.4).

pub fn migration_operation<F>(self, operation: F) -> Self

where F: Fn(u32) -> Result<NewOperation, DbError> + Send + Sync + 'static,

Let sync describe the operation that publishes a breaking migration batch. The database commits its step 1 with the schema, converted waiting writes and migration write. A factory error rolls all of them back. Standalone database users may omit this; the application composition root supplies it.

pub fn clock(self, clock: ClockRef) -> Self

The clock used when stamping a local write (§7.2).

pub fn id_source(self, ids: IdSourceRef) -> Self

The source of fresh names for this store’s owned file bytes (Appendix C.3).

pub fn sqlite_settings(self, settings: SqliteSettings) -> Self

SQLite settings for every connection to the store’s database; unset ones keep SQLite’s defaults, except that checkpoint_fullfsync is on for macOS and iOS (§4).

pub fn sql_functions(self, functions: SqlFunctions) -> Self

The app’s collations and scalar functions, registered on every connection to the store’s database before any app SQL runs on it (§4).

pub async fn open(self) -> Result<Database, OpenError>

Open one writer under the store lock and four read-only connections. Always migrate coven’s internal tables, then rebuild the indexes a new version of SQLite or of the app’s collations and functions changes, then migrate the app’s schema.

pub async fn open_locked(self, lock: StoreLock) -> Result<Database, OpenError>

Open under a lock already held by the facade while checking restored device identity. The lock must protect this builder’s directory.

pub async fn open_read_only(self) -> Result<Database<ReadOnly>, OpenError>

Open read-only connections under a shared deletion guard, without migrating or rebuilding, including from a second process while the writer is open.