Skip to content

About

A Claude Skill for DolphinDB - Time series database documentation, best practices & implementation guides

Resources

Stars

36 stars

Watchers

2 watching

Forks

Repository files navigation

DolphinDB Skill

这是用于 DolphinDB 方案设计、DolphinScript 编码和接口核查的单入口技能。Agent 从 SKILL.md 选择任务路径;读者可从本页学习如何查文档、使用能力卡并验证答案。当前技能版本为 2.2.0。

安装

将整个仓库放入所用 Agent 支持的技能目录,并将文件夹命名为 dolphindb-skill,使 SKILL.md、references/ 和 scripts/ 位于同一文件夹。只复制 SKILL.md 会使参考链接和检索脚本缺失。在该 Agent 的技能目录中运行:

git clone https://github.com/hugo2046/dolphindb_skill.git dolphindb-skill

仓库内的 LATEST_CATALOG.md 可直接打开官方页面;本地全文检索还需提供单独的 HTML 文档快照,见下文的 --root 用法。 已安装旧版 dolphindb 或 dolphindb_skill 的用户,升级后请核对技能目录及调用名称;新版 frontmatter 名称为 dolphindb-skill,避免同时加载两个版本。

快速入门:查到一个新函数

下面的命令在本仓库根目录运行,需要 Python 3.10+ 和仓库同级的 dolphindb_doc/documentation.latest.zh/ 快照。这个例子只读取文档,不需要连接 DolphinDB Server。

  1. 搜索函数名:

    python3 scripts/latest_docs.py search createStatusEngine --limit 2

    当前快照的第一条结果是 funcs/c/createStatusEngine.html。搜索结果给出原始相对路径、标题和正文片段。

  2. 读取该页面的正文:

    python3 scripts/latest_docs.py show funcs/c/createStatusEngine.html

    页面标注首发版本 3.00.6,签名为 createStatusEngine(name, dummyTable, outputTable, keyColumn, [outputPattern="all"])。生成代码前,再按 版本与来源核查卡 对照目标 Server 的实际版本。

你已经取得了可回查的页面路径、版本前提和函数签名。其他函数也按“搜索 → 阅读正文 → 核对运行版本”的顺序处理。

How to:从任务进入正确的能力卡

  1. 确认任务中的数据库、流计算或插件需求,以及目标 Server 和插件版本。版本未知时,先记录为待确认条件。

  2. 按任务打开对应能力卡,再查具体函数页:

    任务 能力卡 交付时核对
    API 签名、版本兼容、旧文档定位 版本与来源核查 运行版本、原始路径、参数签名
    OLAP、TSDB、PKEY、IOT 选型和建表 四引擎选型与建表 查询负载、分区列、引擎专用参数
    时序窗口、乱序数据、快照与 Orca 恢复 流计算与恢复 时间语义、输出表结构、恢复演练
    Backtest 策略与新旧接口 新版回测闭环 行情结构、回调、Server/插件版本
  3. 用 最新文档目录 找标题;若标题不足以定位,运行 search 查正文,随后运行 show 读目标页。交付代码时列明版本、输入表结构和验证查询;没有目标 Server 时,将代码标为按文档核验的骨架。

具体错误码、AI、MCP 等未制成能力卡的主题,也从 最新文档目录 进入原始页面。

How to:使用其他位置的文档快照

检索脚本默认读取仓库同级的 dolphindb_doc/documentation.latest.zh/。快照不在这里时,把 --root 放在子命令前:

python3 scripts/latest_docs.py \
  --root /你的路径/documentation.latest.zh \
  search createBacktester --limit 5

本仓库不包含完整的 HTML 快照。只有技能目录时,仍可在 最新文档目录 点击对应的官方文档链接;本地 search 和 show 需要指定可用的快照目录。

命令参考

运行位置:本仓库根目录。命令入口:scripts/latest_docs.py。

命令 输入 结果
search "词" [--limit N] 必填短语;N 为正整数,默认 20 搜标题和 HTML 正文,标题命中优先,返回匹配总数、路径和片段;不搜索导航栏
show 相对路径.html documentation.latest.zh/ 下存在的 HTML 相对路径 输出该页面的标题和正文;越界路径或没有正文的页面会报错
catalog 无子命令参数 将当前快照的 Markdown 目录写到标准输出
--root 路径 可选全局参数,须放在子命令前 指定本地 HTML 快照根目录

搜索按文本匹配,未命中时可换函数名、主题词或先在 LATEST_CATALOG.md 中查标题。若看到“文档目录不存在”,检查 --root;若 show 提示路径无效,传目录中列出的 .html 相对路径。

资料来源与版本边界

资料 内容 使用边界
LATEST_CATALOG.md 本地快照中 2,883 篇带正文页面的稳定原始路径和官方链接 快照包含 Server 3.00.6 发布说明,不等于目标运行版本
速查表、术语、专题章节 三份白皮书的蒸馏知识及后续勘误 基础材料以 3.00.4 为主;新接口以目标版本函数页为准
白皮书原文 数据库、流数据、回测白皮书 用于理解背景,具体参数仍需查接口页
CATALOG.md 与 references/doc_*.md 历史抓取镜像 目录标题和编号正文可能不一致;按原始 URL 复核

旧镜像有 1,490 条技术文档 URL,但只对应 1,385 个独立编号文件;101 个文件名发生复用。新目录使用官方页面的原始相对路径,避免依赖这些编号。

为什么先查版本与原始路径

文档快照描述的是某个时间点的 API,不能证明目标 Server 或插件已经具备该接口。先核对运行版本,再用函数页确认签名,可以避免把 3.00.6 的示例直接用于较早环境。

旧镜像以编号命名文件,碰撞时一个标题可能打开另一个页面的正文。新目录保留官方页面的相对路径,检索结果可以直接回到本地 HTML 或官方链接。代价是本地全文搜索需要单独保存 HTML 快照;只有技能目录时可使用目录中的在线链接。

维护与验证

更新本地 HTML 快照后,先将新目录生成到临时文件,检查差异,再决定是否替换已提交的目录:

python3 scripts/latest_docs.py catalog > /tmp/dolphindb-latest-catalog.md
diff -u LATEST_CATALOG.md /tmp/dolphindb-latest-catalog.md

检索脚本的行为测试:

python3 -m unittest discover -s tests -p 'test_latest_docs.py' -v

技能入口与适用边界见 SKILL.md,本次变更见 v2.2.0 版本说明。示例代码尚未在目标 Server 或 Backtest 插件上运行;部署前需用实际版本、表结构和数据验证。

About

A Claude Skill for DolphinDB - Time series database documentation, best practices & implementation guides

Resources

Stars

36 stars

Watchers

2 watching

Forks

Releases

Packages

Contributors

Languages