rbdc

Database driver abstraction layer for Rust, providing a unified interface for rbatis.

Table of Contents

• Features
• Supported Databases
• Quick Start
• Scan Utility
• Implement Custom Driver
• License

Features

• Safe: #![forbid(unsafe_code)] - 100% safe Rust
• Async: Native async support based on Tokio
• Extensible: Simple trait definitions for easy driver implementation

Supported Databases

Quick Start

use rbdc_sqlite::SqliteDriver;
use rbdc_pool_fast::FastPool;

#[tokio::main]
async fn main() -> Result<(), rbdc::Error> {
    let pool = FastPool::new_url(SqliteDriver {}, "sqlite://target/test.db")?;
    let mut conn = pool.get().await?;
    let v = conn.exec_decode("SELECT * FROM sqlite_master", vec![]).await?;
    println!("{}", v);
    // if need decode use `let result: Vec<Table> = rbs::from_value(v)?;`
    Ok(())
}

Scan Utility

For memory-efficient row-by-row iteration instead of loading all rows into a Value array at once:

use rbdc::db::Connection;
use rbdc::util::Scan;

let rows = conn.exec_rows("SELECT * FROM activity", vec![]).await?;
let scan = Scan::new(rows);

// Collect all rows into a Vec of struct
#[derive(serde::Deserialize)]
struct Activity {
    id: Option<String>,
    name: Option<String>,
}
let activities: Vec<Activity> = scan.collect()?;

Implement Custom Driver

Implement these 6 traits:

use rbdc::db::{Driver, MetaData, Row, Connection, ConnectOptions, Placeholder};

impl Driver for YourDriver {}
impl MetaData for YourMetaData {
    // TODO: impl methods
}
impl Row for YourRow {
    // TODO: impl methods
}
impl Connection for YourConnection {
    // TODO: impl methods
}
impl ConnectOptions for YourConnectOptions {
    // TODO: impl methods
}
impl Placeholder for YourPlaceholder {
    // TODO: impl methods
}

/// use your driver
#[tokio::main]
async fn main() -> Result<(), rbdc::Error> {
    let uri = "YourDriver://****";
    let pool = FastPool::new_url(YourDriver {}, uri)?;
    let mut conn = pool.get().await?;
    let v = conn.exec_decode("SELECT 1", vec![]).await?;
    println!("{}", v);
}

For databases with blocking APIs, refer to rbdc-sqlite which uses the flume channel library.

See examples for more.

License

MIT