Struct Database

pub struct Database {
    pub db: *mut sqlite3,
}

Fields

db: *mut sqlite3

Implementations

impl Database

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

open an existing sqlite3 database or create a new one.

let database = Database::open(":memory:")?;

pub fn open_with_flags(path: &str, flags: c_int) -> Result<Database>

open a sqlite3 database with explicit flags

use sqlite3_sys as ffi;

let database = Database::open_with_flags(
    ":memory:",
    ffi::SQLITE_OPEN_CREATE | ffi::SQLITE_OPEN_READWRITE
)?;

pub fn prepare(&self, sql: &str) -> Result<Statement<'_>>

prepare a query to be executed

let statement = database.prepare("select 1+2;")?;

pub fn execute(&self, sql: &str, params: impl Bindable) -> Result<()>

Execute an sqlite query.

It is expected that the query does to returns any data, if you need to return data, you should use .query().

pub fn collect<R>(&self, sql: &str, params: impl Bindable) -> Result<R>

where R: Collectable,

Execute a query and collect the results.

Your query must return the same column count as type R If the column index is out of range, you will get Err(SQLITE_RANGE)

let result : (i32, String, f64) = database.collect("select 100, 'hello', 3.14;", ())?;

pub fn for_each<T>( &self, sql: &str, params: impl Bindable, iterable: impl Iterable<(), T>, ) -> Result<()>

for_each iterates over multile rows of data using a colusure

let mut sum = 0;
database.for_each("select 2 union select 3", (), |x: i32| { sum += x; })?;
// sum is 5

Trait Implementations

impl Drop for Database

fn drop(&mut self)

closes the *mut sqlite3 handle on Drop