#sqlite #sqlite3 #embedded-db

sys min-sqlite3-sys

zero dependency, tiny sqlite3 wrapper built for lodpm

9 stable releases

1.4.3 Jun 21, 2023
1.4.2 Jun 16, 2023
1.3.2 May 22, 2022
1.3.1 Apr 20, 2022
0.1.1 Mar 28, 2022

#157 in Database interfaces

Download history 14/week @ 2023-08-14 34/week @ 2023-08-21 19/week @ 2023-09-04 17/week @ 2023-09-11 2/week @ 2023-09-18 4/week @ 2023-09-25 3/week @ 2023-10-02 4/week @ 2023-10-23 23/week @ 2023-10-30 209/week @ 2023-11-06 5/week @ 2023-11-13 28/week @ 2023-11-20 59/week @ 2023-11-27

302 downloads per month

MIT license

9MB
166K SLoC

C 164K SLoC // 0.3% comments Rust 1K SLoC

Very minimal sqlite wrapper package built specifically for lod package manager and Unix systems. If you need complete box of sqlite database, consider using rusqlite.

Adding lib to the project

In your Cargo.toml:

[dependencies]
min-sqlite3-sys = "1.4"

In build.rs of your binary crate:

use std::{env, path::Path};

fn main() {
    let home_path = env::var("HOME").expect("HOME environment variable is not set.");
    let target_dir = Path::new(&home_path).join(".local/share/min_sqlite3_sys");

    println!("cargo:rustc-link-arg=-Wl,-rpath={}", target_dir.display());
}

Usage

Simple usage:

use std::path::Path;

use min_sqlite3_sys::prelude::*;

fn main() {
    let db = Database::open(Path::new("example.db")).unwrap();
    let statement = String::from(
        "CREATE TABLE IF NOT EXISTS items(
                 id      PRIMARY KEY,
                 name    TEXT,
                 tag     TEXT
             );
         ",
    );

    let status = db.execute(
        statement,
        None::<Box<dyn FnOnce(SqlitePrimaryResult, String)>>,
    ).unwrap();

    if status != SqlitePrimaryResult::Ok {
        // handle the problem
    }

    db.close();
}

Simple usage with callback function:

use std::path::Path;

use min_sqlite3_sys::prelude::*;

fn callback_function(status: SqlitePrimaryResult, sql_statement: String) {
    println!(
        "{} did not successfully executed. The error status is: {:?}.",
        sql_statement, status
    );
}

fn main() {
    let db = Database::open(Path::new("example.db"));
    let statement = String::from(
        "CREATE TABLE IF NOT EXISTS items(
                 id      PRIMARY KEY,
                 name    TEXT,
                 tag     TEXT
             );
         ",
    );

    db.execute(statement, Some(callback_function)).unwrap();

    db.close();
}

Simple usage with retrieving some data:

#![allow(dead_code)]
use std::path::Path;

use min_sqlite3_sys::prelude::*;

fn callback_function(status: SqlitePrimaryResult, sql_statement: String) {
    println!(
        "{} did not successfully executed. The error status is: {:?}.",
        sql_statement, status
    );
}

#[derive(Debug)]
struct Item {
    id: i64,
    name: String,
    tag: String,
}

fn main() {
    let db = Database::open(Path::new("example.db")).unwrap();
    let statement = String::from("SELECT * FROM items WHERE name = 'Onur';");

    let mut sql = db.prepare(statement, Some(callback_function)).unwrap();

    // Iterate the results
    while let PreparedStatementStatus::FoundRow = sql.execute_prepared() {
        println!(
            "id = {}, name = {}, tag = {}",
            sql.get_data::<i64>(0).unwrap(),
            sql.get_data::<String>(1).unwrap(),
            sql.get_data::<String>(2).unwrap(),
        );

        // Or simply
        println!(
            "{:?}",
            Item {
                id: sql.get_data(0).unwrap(),
                name: sql.get_data(1).unwrap(),
                tag: sql.get_data(2).unwrap(),
            }
        );
    }
    // Must be called for each `prepare()` result.
    sql.kill();

    db.close();
}

Simple usage with retrieving some data + binding values:

#![allow(dead_code)]
use std::path::Path;

use min_sqlite3_sys::prelude::*;

fn callback_function(status: SqlitePrimaryResult, sql_statement: String) {
    println!(
        "{} did not successfully executed. The error status is: {:?}.",
        sql_statement, status
    );
}

#[derive(Debug)]
struct Item {
    id: i64,
    name: String,
    tag: String,
}

fn main() {
    let db = Database::open(Path::new("example.db")).unwrap();
    let statement = String::from("SELECT * FROM items WHERE name = ?;");

    let mut sql = db.prepare(statement, Some(callback_function)).unwrap();
    let status = sql.bind_val(1, "Onur");
    // You can do some checks by
    assert_eq!(status, SqlitePrimaryResult::Ok);
    // or
    if status == SqlitePrimaryResult::Range {
    	panic!("Out of index on sql.bind_val!");
    }

    // Iterate the results
    while let PreparedStatementStatus::FoundRow = sql.execute_prepared() {
        println!(
            "id = {}, name = {}, tag = {}",
            sql.get_data::<i64>(0).unwrap(),
            sql.get_data::<String>(1).unwrap(),
            sql.get_data::<String>(2).unwrap(),
        );

        // Or simply
        println!(
            "{:?}",
            Item {
                id: sql.get_data(0).unwrap(),
                name: sql.get_data(1).unwrap(),
                tag: sql.get_data(2).unwrap(),
            }
        );
    }
    // Must be called for each `prepare()` result.
    sql.kill();

    db.close();
}

Notes

In order to not inflate the build outputs of your projects, the library executes sqlite functions from dynamic library using C ABI via FFI. Meaning, your build output will not include sqlite sources.

This library does not use any SQLite library on your system to ensure that the package doesn't get affected by SQLite versions. Instead, the sqlite3-builder crate compiles the sqlite3 sources under the c_source directory as dynamic library and puts that under the '~/.local/share/min_sqlite3_sys'.

License

This package is covered under the MIT license. See the LICENSE file for more info.

Dependencies