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.31.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 为来自 time 包 的多种类型实现了 FromSql 和 ToSql。
• url 为来自 url 包 的 Url 类型实现了 FromSql 和 ToSql。
• bundled 使用了捆绑版本的 SQLite。这在需要复杂链接到 SQLite 的情况下是一个好选项，例如 Windows。
• sqlcipher 寻找 SQLCipher 库来链接，而不是 SQLite。此功能覆盖了 bundled。
• bundled-sqlcipher 使用了 SQLCipher 的捆绑版本。它搜索并链接到系统安装的加密库，以提供加密实现。
• bundled-sqlcipher-vendored-openssl 允许使用带有供应商版本的 OpenSSL（通过 openssl-sys 包）的捆绑-sqlcipher 作为加密提供者。
  • 如名称所示，这依赖于 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 包中存储和检索 Uuid 值。
• session，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）。

• 运行 cargo fmt 确保您的Rust代码格式正确。
• 确保 cargo clippy --workspace --features bundled 没有警告通过。
• 确保 cargo clippy --workspace --features "bundled-full session buildtime_bindgen" 没有警告通过。
• 确保 cargo test --workspace --features bundled 报告没有失败。
• 确保 cargo test --workspace --features "bundled-full session buildtime_bindgen" 报告没有失败。

作者

Rusqlite 是许多人辛勤工作的成果。名单在此：[https://github.com/rusqlite/rusqlite/graphs/contributors](https://github.com/rusqlite/rusqlite/graphs/contributors)

社区

欢迎加入 Rusqlite Discord 服务器 讨论或寻求关于 rusqlite 或 libsqlite3-sys 的帮助。

许可证

Rusqlite 和 libsqlite3-sys 在 MIT 许可证下可用。更多信息请参阅 LICENSE 文件。

捆绑软件的许可证

根据启用的 cargo features 集合，rusqlite 和 libsqlite3-sys 还将捆绑其他库，这些库有自己的许可证，如描述 此处。

• 如果启用 --features=bundled-sqlcipher，则将编译和静态链接 SQLcipher 的源代码。SQLcipher 在 BSD-style 许可证下分发，如此处所述。

• 如果启用 --features=bundled，则将编译和链接 SQLite 的源代码。SQLite 处于公有领域，如此处所述。

这两者都很宽松，不会影响 rusqlite 或 libsqlite3-sys 本身的代码许可证，并且如果您不使用这些功能，可以完全忽略。