Struct OverDriveDB 

pub struct OverDriveDB { /* private fields */ }

OverDrive InCode SDK — Embeddable document database

Use this struct to create, open, and interact with OverDrive databases directly in your application. No server required.

Implementations

impl OverDriveDB

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

Open an existing database or create a new one.

File permissions are automatically hardened on open (chmod 600 / Windows ACL).

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

Create a new database. Returns an error if the file already exists.

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

Open an existing database. Returns an error if the file doesn’t exist.

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

Force sync all data to disk.

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

Close the database and release all resources.

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

Delete a database file from disk.

pub fn path(&self) -> &str

Get the database file path.

pub fn version() -> String

Get the SDK version.

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

Open a database with an encryption key loaded securely from an environment variable.

Never hardcode the key — always read from env or a secrets manager.

// In your shell: $env:ODB_KEY="my-secret-32-char-aes-key!!!!"
use overdrive::OverDriveDB;
let mut db = OverDriveDB::open_encrypted("app.odb", "ODB_KEY").unwrap();

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

Create an encrypted backup of the database to dest_path.

Syncs all in-memory data to disk first, then copies the .odb and .wal files. Store the backup in a separate physical location or cloud storage.

db.backup("backups/app_2026-03-04.odb").unwrap();

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

Delete the WAL (Write-Ahead Log) file after a confirmed commit.

Call this after commit_transaction() to prevent attackers from replaying the WAL file to restore deleted data.

let txn = db.begin_transaction(IsolationLevel::ReadCommitted).unwrap();
// ... writes ...
db.commit_transaction(&txn).unwrap();
db.cleanup_wal().unwrap(); // Remove stale WAL

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

Create a new table (schemaless, NoSQL mode).

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

Drop (delete) a table and all its data.

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

List all tables in the database.

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

Check if a table exists.

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

Insert a JSON document into a table. Returns the auto-generated _id.

let id = db.insert("users", &serde_json::json!({
    "name": "Alice",
    "age": 30,
    "tags": ["admin", "developer"]
})).unwrap();
println!("Inserted: {}", id);

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

Insert multiple documents in a batch. Returns a list of generated _ids.

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

Get a document by its _id.

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

Update a document by its _id. Returns true if the document was found and updated.

db.update("users", &id, &serde_json::json!({
    "age": 31,
    "email": "alice@newmail.com"
})).unwrap();

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

Delete a document by its _id. Returns true if found and deleted.

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

Count all documents in a table.

pub fn scan(&self, table: &str) -> SdkResult<Vec<Value>>

Scan all documents in a table (no filter).

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

Execute an SQL query and return results.

Supports: SELECT, INSERT, UPDATE, DELETE, CREATE TABLE, DROP TABLE, SHOW TABLES

let result = db.query("SELECT * FROM users WHERE age > 25 ORDER BY name LIMIT 10").unwrap();
for row in &result.rows {
    println!("{}", row);
}

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

Execute a parameterized SQL query — the safe way to include user input.

Use ? as placeholders in the SQL template; values are sanitized and escaped before substitution. Any param containing SQL injection patterns (DROP, DELETE, --, ;) is rejected with SecurityError.

// SAFE: user input via params, never via string concat
let name: &str = get_user_input(); // could be "Alice'; DROP TABLE users--"
let result = db.query_safe(
    "SELECT * FROM users WHERE name = ?",
    &[name],
).unwrap(); // Blocked: SecurityError if injection detected

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

Full-text search across a table.

pub fn stats(&self) -> SdkResult<Stats>

Get database statistics (expanded with MVCC info).

pub fn begin_transaction( &mut self, isolation: IsolationLevel, ) -> SdkResult<TransactionHandle>

Begin a new MVCC transaction with the specified isolation level.

let txn = db.begin_transaction(IsolationLevel::ReadCommitted).unwrap();
// ... perform reads/writes ...
db.commit_transaction(&txn).unwrap();

pub fn commit_transaction(&mut self, txn: &TransactionHandle) -> SdkResult<()>

Commit a transaction, making all its changes permanent.

pub fn abort_transaction(&mut self, txn: &TransactionHandle) -> SdkResult<()>

Abort (rollback) a transaction, discarding all its changes.

pub fn verify_integrity(&self) -> SdkResult<IntegrityReport>

Verify the integrity of the database.

Checks B-Tree consistency, page checksums, and MVCC version chains. Returns a detailed report.

let report = db.verify_integrity().unwrap();
assert!(report.is_valid);
println!("Checked {} pages across {} tables", report.pages_checked, report.tables_verified);

Trait Implementations

impl Drop for OverDriveDB

fn drop(&mut self)

Executes the destructor for this type.