VillageSQL is a drop-in replacement for MySQL with extensions.
All examples on this page work on VillageSQL. Install Now →
何时选择 C++
在以下情况下,C++ 是正确的选择:- 您的团队已经有 C++ 代码库,并希望扩展使用同一种语言
- 您需要具有精确二进制布局的自定义类型(C++ 类型构建器是最完整的 API)
- 您正在使用现有的 C++ 库,并希望将其作为 SQL 函数公开
先决条件
在编写扩展代码之前,您需要一个 VillageSQL 构建——扩展会链接到服务器的 SDK 头文件和构建树。 您还需要:- C++17 编译器 — GCC 8+、Clang 8+ 或 MSVC 2019+
- CMake 3.18+ — 扩展模板使用 CMake
CMake 设置
最快的入门方式是使用 vsql-extension-template。Fork 它或克隆它:CMakeLists.txt 为您处理了 VEF 的构建设置——复制模板并加以改编,而不是从零编写 CMake。使用 -DVillageSQL_BUILD_DIR 配置构建目录:
-DVillageSQL_BUILD_DIR 告诉 CMake 您的 VillageSQL 构建在哪里,以便它找到 SDK 头文件。这会在构建输出中生成一个 .veb 文件。完整的 CMake 设置请参阅创建扩展和 vsql-extension-template。
一个最小的 C++ VDF
包含 VEF SDK 头文件并使用构建器 API 注册您的函数。下面是一个实现字符串反转函数的完整扩展:- 包含
<villagesql/vsql.h>,而不是<villagesql/extension.h>(那是旧的 V1 头文件) - 类型化参数包装器(
StringArg、IntArg、RealArg)检查空值并公开类型化的值——没有原始指针运算 out.set_null()、out.warning(msg)和out.error(msg)是三种非成功返回VEF_GENERATE_ENTRY_POINTS接受一个make_extension()构建器,而不是原始结构体
.deterministic():
.deterministic()。
构建
在上面 CMake 设置一节的 cmake 配置步骤之后,构建并安装:make install 将 .veb 文件复制到您的 VillageSQL 扩展目录。
安装与测试
连接到 VillageSQL 并安装扩展:mysql-test/t/ 中编写一个 MySQL 测试框架套件:
另请参阅
- 创建扩展 — 完整的 C++ SDK 参考:类型化包装器、自定义类型、聚合函数、系统变量
- 扩展 API 参考 — VDF 约定、空值处理、缓冲区大小、错误语义
- 编写 Rust 扩展 — 完成同一任务的 Rust 路径