SQLite Loadable Rust 扩展框架教程

1. 项目介绍

sqlite-loadable-rs 是一个用于在 Rust 中编写快速且高性能的 SQLite 扩展的框架。SQLite 的运行时可加载扩展允许用户向 SQLite 数据库连接添加新的标量函数、表函数、虚拟表、虚拟文件系统等。传统上，这些扩展主要通过 C/C++ 编写，但 sqlite-loadable-rs 提供了一个更安全和高效的 Rust 实现方式。

2. 项目快速启动

2.1 环境准备

确保你已经安装了 Rust 和 Cargo。如果没有安装，可以通过以下命令安装：

curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

2.2 创建新项目

首先，创建一个新的 Rust 项目：

cargo new --lib my_sqlite_extension
cd my_sqlite_extension

2.3 添加依赖

在 Cargo.toml 文件中添加 sqlite-loadable 依赖：

[package]
name = "my_sqlite_extension"
version = "0.1.0"
edition = "2021"

[dependencies]
sqlite-loadable = "0.0.3"

[lib]
crate-type = ["cdylib"]

2.4 编写扩展代码

在 src/lib.rs 中编写一个简单的扩展函数：

use sqlite_loadable::prelude::*;
use sqlite_loadable::{api, define_scalar_function, Result};

pub fn hello(context: *mut sqlite3_context, values: &[*mut sqlite3_value]) -> Result<()> {
    let name = api::value_text_notnull(values.get(0).expect("1st argument as name"));
    api::result_text(context, format!("hello, {}!", name));
    Ok(())
}

#[sqlite_entrypoint]
pub fn sqlite3_hello_init(db: *mut sqlite3) -> Result<()> {
    define_scalar_function(db, "hello", 1, hello, FunctionFlags::UTF8 | FunctionFlags::DETERMINISTIC);
    Ok(())
}

2.5 构建项目

使用以下命令构建项目：

cargo build

2.6 测试扩展

启动 SQLite CLI 并加载你的扩展：

sqlite3
sqlite> .load target/debug/libmy_sqlite_extension
sqlite> select hello('world');
hello, world!

3. 应用案例和最佳实践

3.1 标量函数

标量函数是 SQLite 中最简单的函数类型，接受输入值并返回输出值。sqlite-loadable-rs 允许你轻松定义标量函数。例如，定义一个简单的加法函数：

pub fn add(context: *mut sqlite3_context, values: &[*mut sqlite3_value]) -> Result<()> {
    let a = api::value_int(values.get(0).expect("1st argument"));
    let b = api::value_int(values.get(1).expect("2nd argument"));
    api::result_int(context, a + b);
    Ok(())
}

#[sqlite_entrypoint]
pub fn sqlite3_extension_init(db: *mut sqlite3) -> Result<()> {
    define_scalar_function(db, "add", 2, add, FunctionFlags::DETERMINISTIC);
    Ok(())
}

3.2 表函数

表函数（也称为“Eponymous-only 虚拟表”）可以通过 define_table_function 添加到扩展中。例如，定义一个返回字符串中字符的表函数：

define_table_function::<CharactersTable>(db, "characters", None);

3.3 虚拟表

sqlite-loadable-rs 还支持传统的虚拟表，这些表具有动态模式或需要插入/更新支持。使用 define_virtual_table 可以定义一个新的只读虚拟表模块：

define_virtual_table::<CustomVtab>(db, "custom_vtab", None);

4. 典型生态项目

以下是一些使用 sqlite-loadable-rs 构建的典型项目：

• sqlite-xsv: 一个极快的 CSV/TSV 解析器。
• sqlite-regex: 一个极快且安全的正则表达式库。
• sqlite-base64: 快速的 base64 编码和解码库。

这些项目展示了 sqlite-loadable-rs 在实际应用中的强大功能和性能优势。