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 为 FromSql 和 ToSql 实现了来自 time crate 的各种类型。
• url 为 FromSql 和 ToSql 实现了来自 url crate 的 Url 类型。
• bundled 使用了内置的 SQLite 版本。这在链接 SQLite 复杂的情况下是一个好选择，例如在 Windows 上。
• sqlcipher 寻找 SQLCipher 库进行链接，而不是 SQLite。这个特性覆盖了 bundled。
• bundled-sqlcipher 使用了内置的 SQLCipher 版本。这会在系统中搜索并链接加密库以提供加密实现。
• bundled-sqlcipher-vendored-openssl 允许使用内置的 SQLCipher 与通过 openssl-sys crate 供应商版本的 OpenSSL（作为加密提供者）一起使用。
  • 如名称所示，这依赖于 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 字节的大端格式存储，最高有效位翻转，这使得存储不同 i128 的 blob 之间的排序和比较能够按预期工作。
• uuid 允许使用 blob 从 uuid 包中存储和检索 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）。