跳转到主要内容

VillageSQL is a drop-in replacement for MySQL with extensions.

All examples on this page work on VillageSQL. Install Now →
VillageSQL 扩展可以使用 villagesql crate 以 Rust 编写。SDK 处理所有 FFI 编组 — 您编写普通的 Rust 代码,extension! 宏会生成服务器在加载时调用的 C 入口点。

何时选择 Rust

在以下情况下,Rust 是正确的选择:
  • 您更喜欢 Rust,并且不需要 C++ 代码库
  • 您想要内存安全,但不想要垃圾回收器
  • 您正在构建一个新扩展,并且没有现有的 C++ 依赖
如果您已有 C++ 代码库,或者需要目前最完整的自定义类型构建器 API,请参阅 编写 C++ 扩展。
该 API 对于扩展开发是稳定的,但自定义类型构建器 API 仍在成熟中。

先决条件

您需要:
  • Rust stable 工具链 — 从 rustup.rs 安装
  • cargo-vsql — 用于打包、安装和测试的 Cargo 子命令
从 SDK 仓库安装 cargo-vsql:

创建新 Crate

创建一个库 crate,添加 SDK,然后进行配置:
然后在 Cargo.toml 中设置 crate 类型:
在 Cargo.toml 旁边添加 manifest.json:

编写函数

用 Rust 构建扩展 页面提供了带有 ROT-13 示例的完整演练。简短版本:实现 fn(&[InValue]) -> VdfReturn,用 func! 注册它,然后用 extension! 包装所有内容:
有关自定义类型(二进制存储、排序、哈希),请参阅 Rust 中的自定义类型。

测试扩展

在 mysql-test/t/basic.test 中编写测试:
设置您的 VillageSQL 构建目录,生成预期结果,然后运行:
通过的运行会为每个测试文件打印 [ pass ]。

在 SQL 中安装

打包并安装:
然后在 SQL 中:

另请参阅