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 包 中的各种类型。
• serde_json 实现了从 FromSql 和 ToSql 为 serde_json 包 中的 Value 类型。
• time 实现了从 FromSql 和 ToSql 为 time 包 中的各种类型。
• url 实现了从 FromSql 和 ToSql 为 url 包 中的 Url 类型。
• bundled 使用了捆绑版本的 SQLite。这对于链接到 SQLite 复杂的情况（如 Windows）是一个好选择。
• sqlcipher 会寻找 SQLCipher 库来链接，而不是 SQLite。这个特性会覆盖 bundled。
• bundled-sqlcipher 使用了捆绑版本的 SQLCipher。它搜索并链接到一个系统安装的加密库，以提供加密实现。
• bundled-sqlcipher-vendored-openssl 允许使用捆绑的 SQLCipher 与 OpenSSL 的捆绑版本（通过 openssl-sys 包）作为加密提供者。
  • 如名称所示，这依赖于 bundled-sqlcipher 特性，并自动开启它。
  • 如果开启，这将使用 openssl-sys 包，并启用 vendored 特性以构建和捆绑 OpenSSL 加密库。
• hooks 为 提交、回滚 和 数据变更 通知回调。
• preupdate_hook 为 preupdate 通知回调。（隐含 hooks。）
• unlock_notify 为 解锁 通知。
• vtab 为 虚拟表 支持（允许你在 Rust 中编写虚拟表实现）。目前，仅支持只读虚拟表。
• series 公开了 generate_series(...) 表值函数。（隐含 vtab。）
• csvtab，使用 Rust 编写的 CSV 虚拟表。（隐含 vtab。）
• array，rarray() 表值函数。（隐含 vtab。）
• i128_blob 允许在 SQLite 数据库中存储 i128 类型的值。内部，数据以 16 字节的大端 blob 存储的，最高有效位被翻转，这使得不同 blob 之间存储 i128 的排序和比较可以按预期工作。
• uuid 允许使用 blob 从 uuid crate 存储和检索 Uuid 值。
• session，Session 模块扩展。需要 buildtime_bindgen 功能。（隐含 hooks。）
• extra_check 在执行只读查询或列数大于 0 时失败。
• column_decltype 为 Statements 和 Rows 提供了 columns() 方法；如果链接到使用 -DSQLITE_OMIT_DECLTYPE 编译的 SQLite/SQLCipher 版本，则省略。
• collation 暴露了 sqlite3_create_collation_v2。
• serialize 暴露了 sqlite3_serialize（3.23.0）。