Skip to main content
VEF Protocol 3 is stable as of v0.0.4. Protocol 4 is under development and is available only via opt-in dev ABI headers (-DVSQL_USE_DEV_ABI=ON). Extensions built against the old Protocol 2 are rejected by the server and must be rebuilt.

概述

VillageSQL 的扩展框架允许您向数据库服务器添加自定义功能。使用 VEF SDK 和扩展模板构建自定义扩展。 本指南涵盖构建和安装扩展的端到端步骤。如需深入了解编写 VDF 实现(类型包装器、聚合、系统变量、参数化类型),请参阅 开发指南
如果您更偏好 Rust,请参阅 使用 Rust 构建扩展

什么是 VillageSQL 扩展?

VillageSQL 扩展打包为 VEB 文件(VillageSQL Extension Bundle),包含:
  • 清单文件 (Manifest) - 有关扩展的元数据(名称、版本、描述)
  • 共享库 (Shared library) - 实现功能的已编译 C++ 代码
  • 可选元数据 - 其他资源或配置
扩展使用 VEF SDK(VillageSQL Extension Framework)构建,该 SDK 提供:
  • 用于定义类型和函数的 C++ API
  • 无需 SQL 脚本的自动注册
  • 类型安全的函数包装器
  • 用于扩展定义的构建器模式
VDF 与传统 UDF 的区别: 通过 VEF SDK 注册的函数称为 VDF(VillageSQL Defined Functions)。VillageSQL 也支持通过 CREATE FUNCTION ... SONAME 注册的传统 MySQL UDF,但对于新扩展,推荐使用 VEF SDK 方式。

在 SQL 中调用 VDF

VDF 可以带或不带扩展前缀进行调用:
函数解析顺序: 当调用未限定的函数时,VillageSQL 按以下顺序解析它:
  1. 系统函数(内置 MySQL 函数,如 NOW()CONCAT()
  2. UDF(传统 MySQL 用户定义函数)
  3. VDF(扩展函数)- 仅当该名称恰好对应一个函数时
  4. 存储函数(使用 CREATE FUNCTION 创建)
何时使用限定名称:
  • 当多个扩展提供同名函数时,使用 extension.function_name
  • 当不存在歧义时,使用非限定名称以获得更简洁的代码
  • 如果仅有一个扩展提供该函数名称,则永远不需要限定
扩展可以添加:
  • 自定义函数 (VDF) - 具有自动类型检查和验证的 SQL 函数
  • 自定义数据类型 - 可与 ORDER BY 和索引配合使用的新列类型,如 COMPLEX、UUID 或 VECTOR
  • 类型操作 - 用于自定义类型的编码、解码、比较和哈希函数

前置条件

在开始之前,请先从源代码构建 VillageSQL——扩展需要链接服务器 SDK 的头文件和构建树。请先遵循 从源代码构建 指南。 您还需要:
  • Git - 用于克隆和版本控制
  • CMake 3.18 或更高版本 - 构建系统
  • C++ 编译器 - GCC 8+、Clang 8+ 或支持 C++17 的 MSVC 2019+
  • 基础 C++ 知识 - 理解 C++ 和函数指针
使用 AI 代理进行构建? vsql-extension-builder 技能可自动化整个工作流程——从脚手架生成到测试——使用 Claude Code、Gemini 或其他支持的代理。使用以下命令安装:

步骤 1:获取扩展模板

您可以通过两种方式开始使用扩展模板:

选项 A:从 VillageSQL 源代码使用模板

如果您拥有 VillageSQL 源代码,则模板已包含在内:

选项 B:从 GitHub Fork

首先 Fork VillageSQL 扩展模板仓库:
  1. 访问 GitHub 上的模板仓库:
  2. 点击 “Fork” 按钮创建您自己的副本
  3. 在本地克隆您的 Fork:
或者,使用 GitHub 上的“Use this template”按钮基于模板创建新仓库,而无需保留 Fork 历史。

步骤 2:更新清单文件

编辑 manifest.json 以定义扩展的元数据:
$schema 字段是可选的,但可为所有清单字段启用 IDE 自动补全和内联验证。

manifest.json 架构

验证规则:
  • name:必须以字母开头,以字母或数字结尾。可包含小写字母、数字、下划线和连字符。最多 64 个字符。使用下划线——连字符在 SQL 中需要反引号引用。
  • version:必须遵循语义化版本控制(例如 1.0.0、0.2.1)
  • 无效的清单文件将导致 INSTALL EXTENSION 失败
示例:
有关 SQL、文件名和仓库名称的完整命名约定,请参阅 扩展命名约定

步骤 3:使用 VEF SDK 实现扩展

VEF SDK 提供了一套 C++ API,使用流畅的构建器模式定义扩展:
  • 具有编译时检查的类型安全函数定义
  • 自动参数验证和类型转换
  • 支持带有比较/哈希函数的自定义类型(启用 ORDER BY 和索引)

包含 VillageSQL 头文件

创建您的主扩展文件(例如 src/extension.cc)并包含 VEF SDK:
<villagesql/vsql.h> 头文件引入了类型构建器、函数构建器和扩展构建器,并将常用符号重新导出到 vsql 命名空间中。

定义您的扩展

使用 VEF_GENERATE_ENTRY_POINTS() 宏定义您的扩展:
函数构建器方法:
  • make_func<&impl>("name") - 使用实现指针创建函数
  • .returns(type) - 设置返回类型(STRING、INT、REAL 或自定义类型名称)
  • .param(type) - 添加参数(最多 8 个参数)
  • .buffer_size(size_t) - 为 STRING/CUSTOM 返回请求特定的输出缓冲区大小
  • .deterministic(bool = true) - 声明此函数对于相同的输入始终返回相同的输出且无副作用。默认情况下为非确定性函数。
  • .prerun<func>() - 设置每条语句的初始化函数(可选)
  • .postrun<func>() - 设置每条语句的清理函数(可选)
  • .build() - 完成函数注册
参数限制: 函数最多支持 8 个参数(由 kMaxParams 定义)。如果需要更多,请考虑使用结构化类型或多个函数。

带有自定义类型参数和返回值的 VDF

VDF 可以使用构建器中的 .param(TYPE_NAME).returns(TYPE_NAME) 接收和返回自定义类型值。实现部分使用 CustomArg 作为输入,使用 CustomResult 作为输出——这与类型操作使用的包装器相同:
使用 .param(COMPLEX).returns(COMPLEX) 进行注册:
有关完整的 CustomArg/CustomResult API(包括用于参数化类型的 CustomArgWith<P>CustomResultWith<P>),请参阅 开发指南

确定性函数

默认情况下,VDF 注册为非确定性函数。非确定性函数在三个 SQL 上下文中被禁用:生成列、CHECK 约束和表达式默认值(列上的 DEFAULT (expr))——将任何这些功能与非确定性 VDF 一起使用都会返回错误。如果您的函数对于相同的输入始终产生相同的输出且无副作用,您可以通过在构建器链中添加 .deterministic() 将其声明为确定性函数。 优化器可能会利用此信息,在每条语句中仅评估一次该函数,并在行之间重用该值,而不是逐行调用。因此,错误地将非确定性函数标记为确定性函数可能导致服务器对应该产生不同输出的输入返回相同的结果。仅当您的函数确实不依赖外部状态、随机性或时间时,才添加 .deterministic() 构建器签名: .deterministic(bool d = true)——无参形式默认为 true 示例:
由于 complex_add 被声明为确定性函数,因此可用于生成列定义中:

自定义缓冲区大小

对于返回变长数据的函数,请指定所需的缓冲区大小:
写入前检查可用缓冲区空间:
请根据函数的最大输出大小,通过 .buffer_size() 请求足够的缓冲区大小。
在实现函数之前,请查阅 扩展 API 参考 以了解完整的 VDF 契约:空值检查、结果类型、缓冲区大小和错误处理。

步骤 4:创建自定义类型

自定义类型允许您定义新的列类型——例如 COMPLEX、UUID 或 VECTOR——这些类型可与 ORDER BY、索引和聚合函数配合使用。 如果您的扩展仅注册函数,请跳至步骤 5。 请参阅 创建自定义类型 获取完整的实现指南。如果您的类型需要参数(例如 VECTOR(1536)), 请参阅 参数化类型

步骤 5:更新构建配置

编辑 CMakeLists.txt 以将您的扩展构建为 VEB 文件:
配置说明:
  • VillageSQLExtensionFramework 提供用于构建扩展的 CMake 辅助工具
  • VEF_CREATE_VEB() 将您的库、清单和元数据打包为 .veb 归档文件
  • 框架会自动检测 MySQL/VillageSQL 构建标志
  • 库目标名称通常为 extension(可以是任意名称)
  • VEB 名称必须与您的 manifest.json 名称匹配
  • 默认情况下,扩展针对稳定的 ABI 头文件进行构建。设置 -DVSQL_USE_DEV_ABI=ON 可改为针对不稳定的开发头文件构建

步骤 6:创建构建目录

创建单独的构建目录:

步骤 7:使用 CMake 和 Make 进行构建

配置并构建您的扩展:
这将生成:
  • 编译后的共享库(.so 文件)
  • VEB 包(.veb 文件)- 包含清单和库的 tar 归档文件

验证构建结果

检查您的 VEB 文件内容:
您应该看到:

步骤 8:安装与测试

选项 A:安装到 VillageSQL 扩展目录

使用 install 目标将 VEB 复制到您的 VillageSQL 安装目录:
这会将 .veb 文件复制到通过 VillageSQL_VEB_INSTALL_DIR 配置的目录中。

选项 B:手动安装

手动复制 VEB 文件:

测试您的扩展

  1. 连接到 VillageSQL
  2. 安装扩展
  3. 验证安装
  4. 测试您的函数

创建测试

添加测试文件以验证您的扩展是否正常工作:
  1. mysql-test/t/ 中创建测试文件
  2. 生成预期结果
  3. 运行测试

故障排除

扩展无法加载

检查错误日志并验证 VEB 内容:

未找到函数

验证安装和注册情况:

构建错误

示例扩展

从现有的 VillageSQL 扩展中学习:

vsql_complex

复数数据类型实现

vsql_extension_template

用于创建扩展的最小模板

后续步骤

使用扩展

了解如何安装和管理扩展

开发指南

类型包装器、聚合函数、系统变量和测试

扩展架构

生命周期、缓存、性能和安全模型

从源码构建

从源代码构建 VillageSQL

资源