Rusqlite

Rusqlite是Rust使用SQLite的便捷封装。

历史上，API基于rust-postgres的API。然而，这两个在许多方面都有所不同，且没有打算两者之间兼容。

用法

在你的Cargo.toml中

[dependencies]
# `bundled` causes us to automatically compile and link in an up to date
# version of SQLite for you. This avoids many common build issues, and
# avoids depending on the version of SQLite on the users system (or your
# system), which may be old or missing. It's the right choice for most
# programs that control their own SQLite databases.
#
# That said, it's not ideal for all scenarios and in particular, generic
# libraries built around `rusqlite` should probably not enable it, which
# is why it is not a default feature -- it could become hard to disable.
rusqlite = { version = "0.32.0", features = ["bundled"] }

简单示例用法

use rusqlite::{Connection, Result};

#[derive(Debug)]
struct Person {
    id: i32,
    name: String,
    data: Option<Vec<u8>>,
}

fn main() -> Result<()> {
    let conn = Connection::open_in_memory()?;

    conn.execute(
        "CREATE TABLE person (
            id    INTEGER PRIMARY KEY,
            name  TEXT NOT NULL,
            data  BLOB
        )",
        (), // empty list of parameters.
    )?;
    let me = Person {
        id: 0,
        name: "Steven".to_string(),
        data: None,
    };
    conn.execute(
        "INSERT INTO person (name, data) VALUES (?1, ?2)",
        (&me.name, &me.data),
    )?;

    let mut stmt = conn.prepare("SELECT id, name, data FROM person")?;
    let person_iter = stmt.query_map([], |row| {
        Ok(Person {
            id: row.get(0)?,
            name: row.get(1)?,
            data: row.get(2)?,
        })
    })?;

    for person in person_iter {
        println!("Found person {:?}", person.unwrap());
    }
    Ok(())
}

支持的SQLite版本

基本的rusqlite包支持SQLite版本3.14.0或更高。如果您需要支持旧版本，请提交一个问题。某些Cargo功能需要更新的SQLite版本；请参阅以下详细信息。

可选功能

Rusqlite提供了一些在Cargo功能之后的功能。它们是

• load_extension 允许加载基于动态库的SQLite扩展。
• loadable_extension 允许在Rust中编程可加载扩展。
• backup 允许使用SQLite的在线备份API。
• functions 允许将Rust闭包加载到SQLite连接中，以便在查询中使用。
• window 用于窗口函数支持（fun(...) OVER ...）。(隐含functions。)
• trace 允许钩子到SQLite的跟踪和性能分析API。
• blob 提供了对 SQL BLOB 的 std::io::{Read, Write, Seek} 访问。
• limits 允许您设置和检索 SQLite 的每个连接限制。
• chrono 为 FromSql 和 ToSql 实现了来自 chrono crate 的各种类型。
• serde_json 为 FromSql 和 ToSql 实现了来自 serde_json crate 的 Value 类型。
• time 为来自 time crate 的各种类型实现了 FromSql 和 ToSql。
• url 为来自 url crate 的 Url 类型实现了 FromSql 和 ToSql。
• bundled 使用了捆绑版的 SQLite。这对于像 Windows 这样链接到 SQLite 复杂的情况来说是一个好选择。
• sqlcipher 寻找 SQLCipher 库来链接，而不是 SQLite。此功能覆盖了 bundled。
• bundled-sqlcipher 使用了 SQLCipher 的捆绑版本。它搜索并链接到一个系统安装的加密库来提供加密实现。
• bundled-sqlcipher-vendored-openssl 允许使用带有供应商版本的开源 OpenSSL（通过 openssl-sys crate）作为加密提供者的捆绑 sqlcipher。
  • 如名称所示，这依赖于 bundled-sqlcipher 功能，并自动将其打开。
  • 如果打开，则使用具有启用 vendored 功能的 openssl-sys crate，以构建和捆绑 OpenSSL 加密库。
• hooks 用于 提交、回滚 和 数据更改 通知回调。
• preupdate_hook 用于 预更新 通知回调。（隐含 hooks。）
• unlock_notify 用于 解锁 通知。
• vtab 用于 虚拟表 支持（允许您在 Rust 中编写虚拟表实现）。目前，仅支持只读虚拟表。
• series 公开了 generate_series(...) 表值函数。（隐含 vtab。）
• csvtab，用Rust编写的CSV虚拟表。（意味着 vtab。）
• array，表值函数 rarray()。（意味着 vtab。）
• i128_blob 允许在SQLite数据库中存储 i128 类型的值。内部，数据以16字节的big-endian blob形式存储，最高有效位被反转，这使得存储i128的不同blob之间的排序和比较能够按预期工作。
• uuid 允许使用blob从 uuid crate 存储和检索 Uuid 值。
• session，会话模块扩展。需要 buildtime_bindgen 功能。（意味着 hooks。）
• extra_check 当传递给执行查询为只读或列数 > 0 时会失败。
• column_decltype 为语句和行提供 columns() 方法；如果链接到使用 -DSQLITE_OMIT_DECLTYPE 编译的SQLite/SQLCipher版本，则省略。
• collation公开了 sqlite3_create_collation_v2。
• serialize公开了 sqlite3_serialize（3.23.0）。