Rust辅助库，用于Scylla UDFs

此crate允许编写纯Rust函数，这些函数可以用作Scylla UDFs。

注意：此crate官方支持且可用。然而，UDFs仍然是ScyllaDB的一个实验性特性，该crate尚未广泛应用，因此它仍然处于beta版本，其API可能发生变化。我们感谢错误报告和pull请求！

用法

先决条件

要在Scylla中使用此辅助库，您需要

• Rust标准库 wasm32-wasi
  • 可以在rustup安装中使用以下命令添加：rustup target add wasm32-wasi
  • 对于非rustup配置，您可以尝试遵循以下步骤：https://wasm.rust-lang.net.cn/docs/wasm-pack/prerequisites/non-rustup-setups.html
  • 也可作为rpm提供： rust-std-static-wasm32-wasi
• wasm2wat 解析器
  • 在许多发行版的 wabt 软件包中提供

编译

我们推荐使用cargo配置。

1. 从库包开始

cargo new --lib

2. 将以下行添加到Cargo.toml中，以设置crate类型为cdylib

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

3. 实现您的包，使用scylla_udf::export_udf宏导出Scylla UDFs。
4. 使用wasm32-wasi目标构建包

cargo build --target=wasm32-wasi

5. 找到编译后的.wasm二进制文件。假设它是target/wasm32-wasi/debug/abc.wasm。
6. （可选）使用 wasm-opt -O3 target/wasm32-wasi-debug/abc.wasm 优化二进制代码（可以与使用 cargo build --release 配置文件）
7. 将二进制代码翻译为 wat

wasm2wat target/wasm32-wasi/debug/abc.wasm > target/wasm32/wasi/debug/abc.wat

CQL 语句

生成的 target/wasm32/wasi/debug/abc.wat 代码现在可以直接在 CREATE FUNCTION 语句中使用。生成的代码可能包含 ' 字符，因此可能需要先将它们替换为 ''，以便在 CQL 字符串中使用。

例如，如果你有一个使用逗号连接单词列表的 Rust UDF，你可以使用以下语句创建 Scylla UDF

CREATE FUNCTION commas(string list<text>) CALLED ON NULL INPUT RETURNS text AS ' (module ...) '

CQL 类型映射

使用 #[export_udf] 注释的函数中使用的参数和返回值类型必须映射到 Scylla 中使用的 CREATE FUNCTION 语句中的 CQL 类型，如下表所示。

如果 Scylla 函数是用与 Rust 函数中使用的类型不匹配的类型创建的，则调用 UDF 将失败或产生任意结果。

本地类型

集合

如果 CQL 类型 T 映射到 Rust 类型 RustT，则可以使用它作为集合参数

元组

如果 CQL 类型 T1、T2、... 映射到 Rust 类型 RustT1、RustT2、...，则可以在元组中使用它们

空值

如果映射到类型 RustT 的 CQL 值 T 可能是空值（在非 RETURNS NULL ON NULL INPUT UDFs）中，则 Rust 函数中使用的类型应为 Option<RustT>。

CARGO_TARGET_WASM32_WASI_RUNNER="wasmtime --allow-unknown-exports" cargo test --target=wasm32-wasi