DuckDB 的 C 类型不会出现在你的代码里。你写的是普通 Rust —— Option、Vec、派生结构体与枚举 —— 其余交给属性宏。
只依赖头文件、不链接库:扩展在加载时通过 DuckDB 的 API 表完成分发,因此无需本地编译,交叉编译也能正常工作。
函数体内没有 unsafe 函数、也没有裸指针;仅显式手动注册处还保留着 unsafe。
给函数加个注解就够了:注册项会被自动收集,并在 DuckDB 加载扩展时应用。
函数体内的 panic 会被捕获并作为 DuckDB 错误上报,而不是展开着穿过 FFI 边界。
Vec、IndexMap、定长数组、STRUCT 以及它们的任意嵌套,都对应到 DuckDB 的 LIST、MAP、ARRAY 与 STRUCT。
一个 Rust 函数 = 一个 SQL 函数
属性宏会生成 FFI 包装层、列的读写与注册代码。左边这段是安全的 Rust,和写普通库时没有区别。
src/lib.rs
use duckfn::{
duck_error, duck_scalar_function, duckfn_entrypoint, DuckOptionResult,
};
/// The SQL below is what this function becomes, doc comment and all.
#[duck_scalar_function]
pub fn double_it(v: Option<i64>) -> DuckOptionResult<i64> {
if v == Some(13) {
return Err(duck_error("unlucky input"));
}
Ok(v.map(|x| x * 2))
}
// The symbol DuckDB looks for when it loads the extension.
duckfn_entrypoint!("my_ext");
duckdb -unsigned
-- the extension loads like any other
LOAD './my_ext.duckdb_extension';
SELECT double_it(21); -- 42
SELECT double_it(NULL); -- NULL
SELECT double_it(13); -- error: unlucky input
注释就是每次调用的返回值。加载时要加 -unsigned,因为扩展调用的是 DuckDB 的 C API。
编写、构建并加载你的第一个扩展。
全部属性、参数与注册方式,附示例。
一个用到了 duckfn 全部能力的扩展。
从 DuckDB 加载这个动态库,到你的函数回答一条查询。