Struct SharedDB 

pub struct SharedDB { /* private fields */ }

A thread-safe, cheaply-cloneable handle to an OverDriveDB.

Internally wraps the database in an Arc<Mutex<OverDriveDB>>. Multiple SharedDB instances pointing to the same database can be safely sent across threads.

Locking

Each .with() call acquires the mutex for the duration of the closure. Keep closures short to avoid blocking other threads.

Implementations

impl SharedDB

pub fn open(path: &str) -> SdkResult<Self>

Open (or create) a database wrapped in a thread-safe handle.

File permissions are hardened automatically on open.

pub fn open_encrypted(path: &str, key_env_var: &str) -> SdkResult<Self>

Open with an encryption key from an environment variable.

use overdrive::shared::SharedDB;
// $env:ODB_KEY="my-aes-256-key"
let db = SharedDB::open_encrypted("app.odb", "ODB_KEY").unwrap();

pub fn with<F, T>(&self, f: F) -> SdkResult<T>

where F: FnOnce(&mut OverDriveDB) -> T,

Execute a closure with exclusive access to the database.

The mutex is acquired for the duration of f and released when it returns. Returns SecurityError if the mutex has been poisoned by a panicking thread.

let count = db.with(|d| d.count("users")).unwrap();

pub fn query(&self, sql: &str) -> SdkResult<QueryResult>

Convenience: execute an SQL query.

pub fn query_safe( &self, sql_template: &str, params: &[&str], ) -> SdkResult<QueryResult>

Convenience: execute a safe parameterized SQL query.

See OverDriveDB::query_safe() for full documentation.

pub fn insert(&self, table: &str, doc: &Value) -> SdkResult<String>

Convenience: insert a document into a table.

pub fn get(&self, table: &str, id: &str) -> SdkResult<Option<Value>>

Convenience: get a document by _id.

pub fn backup(&self, dest_path: &str) -> SdkResult<()>

Convenience: create a backup at dest_path.

pub fn sync(&self) -> SdkResult<()>

Convenience: sync to disk.

pub fn handle_count(&self) -> usize

Number of SharedDB handles pointing to this same database (Arc strong count).

Trait Implementations

impl Clone for SharedDB

fn clone(&self) -> SharedDB

Returns a duplicate of the value.

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

Performs copy-assignment from source.