dataease·dataease/SQLBot/AGENTS.md

SQLBot

AGENTS.md7k starsChanged 15 months agoLicence not identifiedView on GitHub

SQLBot 让业务用户用自然语言提问，基于已配置的数据源生成并安全执行 SQL，返回数据、图表、分析和后续问题建议。领域词汇表见 CONTEXT.md。 本文及按需文档是开发约定，不是现有实现已满足所有约束的证明。文档与实现冲突时先核实并报告差异，不要为迎合旧实现削弱安全要求；易漂移的实现细节注明源码入口或适用版本，避免多处复制。领域词汇约定不要求重命名现有 API、数据库字段或翻译键。 商业扩展源码维护在独立仓库 dataease/sqlbot-xpack。它不是 submodule，也不是本仓库的固定子目录。本地 sqlbot-xpack/ checkout 会被主仓库忽略，永远不应出现在本仓库 PR 中。 默认使用开源版 SQLBot 工作流：把 sqlbot-xpack 视为版本范围由 backend/pyproject.toml 约束的已发布 wheel（精确版本冻结在不入库的 uv.lock）。不读取、不修改本地 xpack checkout。 只有任务确实需要修改或调试闭源 xpack 代码，或需要两个仓库联动验证时，才按 docs/agents/xpack.md 检查本地关联开关（AGENTS.local.env）并协调两个仓库的变更。

• Reads credentials