Rusqlite

Rusqlite 是从 Rust 使用 SQLite 的便捷包装。

历史上，API 基于来自 rust-postgres 的一个。然而，两者在很多方面已经分化，没有打算两者之间兼容。

使用方法

在你的 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.29.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 扩展。
• 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 包 的各种类型。
• serde_json 为 FromSql 和 ToSql 实现了来自 serde_json 包 的 Value 类型。
• time 为来自 time 包 的 time::OffsetDateTime 类型实现了 FromSql 和 ToSql。
• url 为来自 url 包 的 Url 类型实现了 FromSql 和 ToSql。
• bundled 使用了SQLite的捆绑版本。这在Windows等链接SQLite比较复杂的情况下是一个好选择。
• sqlcipher 寻找SQLCipher库进行链接，而不是SQLite。这个特性覆盖了 bundled。
• bundled-sqlcipher 使用SQLCipher的捆绑版本。这会搜索并链接到系统安装的加密库，以提供加密实现。
• bundled-sqlcipher-vendored-openssl 允许使用捆绑的SQLCipher与捆绑版本的OpenSSL（通过 openssl-sys 包）一起作为加密提供者。
  • 正如其名所示，这依赖于 bundled-sqlcipher 特性，并自动打开它。
  • 如果打开，这将使用具有 vendored 特性启用的 openssl-sys 包来构建和捆绑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 包存储和检索 Uuid 值。
• session，会话模块扩展。需要buildtime_bindgen特性。（隐含hooks。）
• extra_check在执行查询时，如果查询为只读或有列数>0时将失败。
• column_decltype为语句和行提供columns()方法；如果链接到使用-DSQLITE_OMIT_DECLTYPE编译的SQLite/SQLCipher版本，则省略。
• collation公开sqlite3_create_collation_v2。
• winsqlite3允许链接到Windows较新版本中存在的SQLite。