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.28.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.6.8或更高版本。如果您需要支持较旧版本，请提交问题。一些Cargo功能需要较新的SQLite版本；请参见以下详细信息。

可选功能

Rusqlite提供了几个在 Cargo功能 之后的特性。它们是：

• load_extension 允许加载基于动态库的SQLite扩展。
• backup 允许使用SQLite的在线备份API。注意：此功能需要SQLite 3.6.11或更高版本。
• functions 允许您将Rust闭包加载到SQLite连接中，以便在查询中使用。注意：此功能需要SQLite 3.7.3或更高版本。
• window 用于 窗口函数 支持（fun(...) OVER ...）。（隐含 functions。）
• trace 允许钩子进入SQLite的跟踪和剖析API。注意：此功能需要SQLite 3.6.23或更高版本。
• blob 为SQL BLOB提供 std::io::{Read, Write, Seek} 访问。注意：此功能需要SQLite 3.7.4或更高版本。
• limits 允许您设置和检索 SQLite 的每个连接限制。
• chrono 为 FromSql 和 ToSql 实现了来自 chrono crate 的各种类型。
• serde_json 为 serde_json crate 中的 Value 类型实现了 FromSql 和 ToSql。
• time 为来自 time crate 的 time::OffsetDateTime 类型实现了 FromSql 和 ToSql。
• url 为来自 url crate 的 Url 类型实现了 FromSql 和 ToSql。
• bundled 使用 SQLite 的捆绑版本。这对于链接到 SQLite 复杂的情况，如 Windows，是一个好选择。
• sqlcipher 寻找 SQLCipher 库进行链接，而不是 SQLite。此功能覆盖了 bundled。
• bundled-sqlcipher 使用 SQLCipher 的捆绑版本。它搜索并链接到一个系统安装的加密库以提供加密实现。
• bundled-sqlcipher-vendored-openssl 允许使用带有 OpenSSL（通过 openssl-sys crate）的捆绑版本作为加密提供者的 bundled-sqlcipher。
  • 正如其名所示，这依赖于 bundled-sqlcipher 功能，并自动将其打开。
  • 如果打开，这会使用 openssl-sys crate，并启用 vendored 功能来构建和捆绑 OpenSSL 加密库。
• 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，会话模块扩展。需要 buildtime_bindgen 功能。（隐含 hooks。）
• extra_check 在执行传递的查询为只读或有列数 > 0 时失败。
• column_decltype 为 Statements 和 Rows 提供 columns() 方法；如果链接到使用 -DSQLITE_OMIT_DECLTYPE 编译的 SQLite/SQLCipher 版本，则省略。
• collation 提供了 sqlite3_create_collation_v2。
• winsqlite3 允许链接到 Windows 新版本中存在的 SQLite。