SuperAPI AI 工具集

surrealql-functions

通用与其它

查看项目

更新于 10-15 21:05

技能介绍

用途:帮助开发者发现并正确使用 SurrealDB 内置的 SurrealQL 函数(如 string::、array::、math::、type:: 等命名空间),并获取与已安装 SurrealDB 版本一致的准确签名。

主要能力:SurrealQL 语言服务器(LSP)提供内置函数补全、带类型信息与函数签名的悬停提示,以及输入调用时的签名帮助;surrealql-tree-sitter 是 LSP 解析所用的语法(面向 SurrealDB v3+)。函数到权威文档的映射见 references/catalog.md。

适用场景:查询某内置函数的作用或确切参数;为 .surql 文件获取实时补全、悬停与签名帮助;确认某函数在已安装版本中是否存在或签名是否符合预期,避免输出已更名或移除的函数。

安装:从 crates.io 安装语言服务器,已发布 crate 自带语法,无需单独检出 tree-sitter: cargo install surrealql-language-server 验证:surrealql-language-server --help

从源码构建(可选,仅开发或跟踪未发布变更时需要): git clone https://github.com/surrealdb/surrealql-language-server.git cd surrealql-language-server bash scripts/setup-grammar.sh cargo build --release 浏览器/编辑器嵌入可改用 bash scripts/build-wasm.sh(输出到 pkg/)。

编辑器集成:将编辑器的 LSP 客户端指向 surrealql-language-server 二进制,文件类型为 *.surql。

使用方式:打开或创建连接 LSP 的 .surql 缓冲区;输入命名空间前缀(如 string::)触发补全以枚举该命名空间的内置函数;悬停函数调用或在括号内调用签名帮助查看确切签名与参数类型。补全与签名来自已安装语法,反映当前 SurrealDB 版本。

限制:资料未提供具体函数清单、收费信息或平台支持范围;需自行安装语言服务器并配置编辑器 LSP 客户端。