1. 基本信息
| 项目 | 内容 | 数据来源 |
|---|---|---|
| 名称 | doris-best-practices-apache-doris-skills | — |
| 项目自述名称 | Apache Doris Best Practices(SKILL.md 自身标题) | SKILL.md 实测 |
| 作者/维护者 | Apache Software Foundation(Apache Doris 项目组,官方 GitHub 组织账号 apache) | GitHub API 实测 |
| 来源链接 | https://github.com/apache/doris-skills/tree/main/skills/doris-best-practices | — |
| 许可证 | Apache-2.0 | GitHub API 实测 |
| GitHub Stars / Forks | 22 / 6(apache/doris-skills 仓库整体口径;该仓库是 Apache Doris 官方配套技能仓库,共含 4 个技能,数字不代表本技能独立热度) |
GitHub API 实测(2026-07-30) |
| 最新版本 | 0.1.0(SKILL.md 自身 metadata 字段) | SKILL.md 实测 |
| 安装方式 | npx skills add apache/doris-skills,或手动 cp -r skills/doris-best-practices ~/.claude/skills/ |
官方 README 实测 |
2. 功能介绍与亮点
把 Apache Doris(一款列式 OLAP 分析数据库)工程师踩过的建表与调优坑,编码成 37 条规则 + 7 套典型场景模板 + 4 份容量测算指南,共 48 份参考文档:
- 问题优先路由:正文开篇即是“我要构建……“对照表,按实时日志分析、CDC 同步、看板预聚合、点查、星型join等 12 种常见场景,直接映射到对应模板与规则,而非要求用户先学会 Doris 全部概念
- 建表前置检查清单:数据模型、分区策略、分桶键/数量、排序键顺序、字段类型、索引、属性逐项核对,并列出一批 Doris 会直接拒绝执行的 DDL 硬约束(如分区列必须在 UNIQUE KEY 内、AUTO PARTITION 语法细节等)
- 慢查询排查表:先引导查看
profile/EXPLAIN等运行时证据,再对照症状定位规则,避免凭猜测调优 - 可验证:仓库自带三层回归测试套件(L1 对照真实集群校验每条 DDL 结论、L2 校验命令行工具契约、L3 端到端行为测试),内容不是纸面文档而是持续跑测的断言
3. 适用场景
固定分类:数据分析与可视化
用 Claude Code 等 agent 设计 Apache Doris 表结构、诊断慢查询、或从 ClickHouse/Elasticsearch/Presto/Hive 等旧栈迁移评估分区分桶策略的开发者与数据工程师;尤其适合刚接触列式 OLAP 数据库、容易套用传统关系型建表直觉的用户。
4. 跨 Agent 兼容性
- Claude Code:原生支持——README 提供
npx skills add命令与手动复制到~/.claude/skills/两种路径 - Codex:原生支持——README 明确将
skillsCLI 描述为“适用于 Claude Code、Cursor、Codex、Cline、Amp 等 agent 工具”,点名列出 Codex - OpenClaw:未验证——抓取材料未提及
- Hermes Agent:未验证——抓取材料未提及
5. 推荐理由
Apache Doris 官方把工程师内部踩过的建表与调优坑,编码成一份可引用、且用真实集群持续回归测试验证过的规则库,而不是一份可能过期的博客——agent 设计表结构或排查慢查询时能直接对照规则给出“当前写法/应改写法”,比让 agent 凭通用 SQL 直觉临场发挥更可靠,对刚从其他数据库迁移过来的用户帮助尤其明显。
6. 评分
| 维度 | 分数 | 说明 |
|---|---|---|
| 受欢迎程度 | 7 | Apache 官方组织出品;本仓库创建于 2026-05-28,22 stars / 6 forks,未见独立第三方讨论或企业级外部贡献者参与 |
| 可用性 | 9 | 一条命令或手动复制即可用;48 份参考文档结构清晰、示例完整;仓库近一周内仍有提交,维护活跃;无需付费账号或额外账号注册即可完整使用 |
| 安全性 | 9 | 见下方安全检查清单 |
| 综合 | 8.3 | 三项均值 |
安全检查清单:
| 检查项 | 结果 |
|---|---|
| ① Shell 命令执行 | 技能本身为纯 Markdown 参考文档,不含任何可执行脚本;文中给出的 SQL/DDL 语句需用户自行在自己的数据库客户端执行 |
| ② 联网外发 | 无默认外联;技能不会自行连接任何网络服务 |
| ③ API key/凭据 | 不涉及任何凭据;如需读取运行时 profile/tablet 信息,走用户自己配置的数据库连接,技能本身不存储或索取密钥 |
| ④ 可疑指令 | SKILL.md 与全部参考文档中未发现要求执行特权操作或数据外发的可疑指令 |
| ⑤ 作者信誉 | Apache Software Foundation 官方组织账号,主要提交者为 Apache Doris 项目 PMC 成员 |
| ⑥ License | Apache-2.0,明确 |
| ⑦ 维护时间 | 仓库最近一次提交距报告发布 6 天,活跃维护 |
7. 跟同类 Skills 相比的优势
同为“数据库厂商官方建表/调优规则库”类型的技能,与本技能的定位差异:
| 技能 | 厂商 | 覆盖范围 | 是否需付费账号 | 独有特点 |
|---|---|---|---|---|
| Doris Best Practices(本次推荐) | Apache Doris | 37 条规则+7套场景模板+4份容量指南,覆盖建表/慢查询/迁移 | 否,开源自建即可用 | 唯一附带针对真实集群持续跑测的三层回归测试套件;场景模板按“我要构建……“问题导向直接路由 |
| ClickHouse Best Practices | ClickHouse Inc | 31 条规则,schema/查询/插入/agent 安全 | 否 | 规则里内置 agent 查询安全护栏(强制 LIMIT、超时) |
| MongoDB Schema Design | MongoDB, Inc | 建模模式与反模式,侧重嵌入 vs 引用决策 | 否 | 面向文档型数据库,与列式 OLAP 场景不重叠 |
| 同仓库姊妹技能 doris-architecture-advisor / doris-profile-reader | Apache Doris | 分别聚焦架构选型、慢查询 profile 解读 | 否 | 与本技能互补而非竞争,三者合起来覆盖“选型-建表-排障”全链路 |
核心差异化:在同类“数据库官方最佳实践”技能里,本技能是目前唯一把内容真实性做成可复跑的回归测试套件(而非仅靠人工审校)的一款。
8. 用户评价
该技能目前在第三方平台尚无具名用户评价:仓库创建仅两个月,公开渠道未见独立博客、论坛或社交媒体讨论。
9. 其他补充
仓库同时含 doris-architecture-advisor(架构选型,8条决策规则+10个行业案例)、doris-profile-reader(查询 profile 解读)、doris-debug(生产诊断路由,含 10 个更细粒度的领域子技能)三个姊妹技能,可按需单独安装。本技能可选搭配官方 CLI 工具 doriscli(npm install -g @apache-doris/doriscli)获得结构化诊断能力,未安装时会自动回退到标准 MySQL 协议 SQL + FE HTTP API,不影响核心建表指导功能。
10. 安装使用方式
- 推荐方式:
npx skills add apache/doris-skills(会自动发现仓库内全部技能并一并打包其references/目录) - 手动方式:克隆仓库后执行
cp -r skills/doris-best-practices ~/.claude/skills/ - 安装后无需重启;agent 在处理
CREATE TABLE、分区分桶设计、慢查询排查、或从 ClickHouse/Elasticsearch/Hive 等旧栈迁移评估时会按 SKILL.md 描述自动触发 - 如需结构化诊断真实集群(读取 profile、tablet 分布),可额外安装
doriscli命令行工具
11. 注意事项
- 技能面向 Apache Doris 通用场景设计,正文明确不涉及托管服务的集群生命周期、计费、网络等运维操作,这类操作需使用对应平台自己的管理控制台
- 本技能是仓库
apache/doris-skills中的一个子目录,仓库同时含另外 3 个技能,只需建表/调优指导时装本子目录即可 - Codex 之外的 OpenClaw、Hermes Agent 兼容性未获官方明确声明,跨 agent 使用前建议自行验证 SKILL.md 能否被目标 agent 正确加载
- 结构化诊断真实集群的 profile/tablet 信息需额外安装
doriscli或自行配置数据库连接,基础建表规则指导不需要