Struct OverdriveDb 

pub struct OverdriveDb { /* private fields */ }

OverDrive-DB embedded database handle.

All operations use odb as the idiomatic instance name:

let mut odb = OverdriveDb::open("app.odb").unwrap();
odb.insert("users", &serde_json::json!({"name":"Alice"})).unwrap();

Implementations

impl OverdriveDb

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

Open or create a database at path.

pub fn open_with_options(path: &str, opts: OpenOptions) -> Result<Self>

Open with engine and/or password options.

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

Flush all pending writes to disk.

pub fn close(self) -> Result<()>

Close the database explicitly (also called on Drop).

pub fn version() -> String

Return the native library version string.

pub fn create_table(&mut self, name: &str) -> Result<()>

Create a table.

pub fn drop_table(&mut self, name: &str) -> Result<()>

Drop a table.

pub fn list_tables(&self) -> Result<Vec<String>>

List all tables.

pub fn table_exists(&self, name: &str) -> Result<bool>

Check if a table exists.

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

Insert a JSON document. Returns the generated _id.

pub fn insert_batch( &mut self, table: &str, docs: &[Value], ) -> Result<Vec<String>>

Insert multiple documents. Returns a Vec of generated _ids.

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

Get a document by _id. Returns None if not found.

pub fn update(&mut self, table: &str, id: &str, patch: &Value) -> Result<bool>

Update a document by _id. Returns true if updated.

pub fn delete(&mut self, table: &str, id: &str) -> Result<bool>

Delete a document by _id. Returns true if deleted.

pub fn count(&self, table: &str) -> Result<usize>

Count documents in a table.

pub fn query(&mut self, sql: &str) -> Result<Vec<Value>>

Execute a SQL query. Returns rows as a Vec of JSON Values.

pub fn search(&self, table: &str, text: &str) -> Result<Vec<Value>>

Full-text search across a table.

pub fn begin_transaction(&mut self, iso: IsolationLevel) -> Result<Transaction>

Begin an MVCC transaction.

pub fn commit_transaction(&mut self, txn: &Transaction) -> Result<()>

Commit a transaction.

pub fn abort_transaction(&mut self, txn: &Transaction) -> Result<()>

Abort (rollback) a transaction.

pub fn transaction<F, T>(&mut self, iso: IsolationLevel, f: F) -> Result<T>

where F: FnOnce(&mut Self) -> Result<T>,

Run a closure inside a transaction — auto commits on Ok, aborts on Err.

pub fn verify_integrity(&self) -> Result<Value>

Run an integrity check. Returns a JSON report.

Trait Implementations

impl Drop for OverdriveDb

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl Send for OverdriveDb