SQL索引推荐审查器

--- name: sql-index-recommendation-reviewer description: 审查数据库模式（schema）和慢SQL查询，按正确列顺序（等值、排序、范围）提出复合索引建议，包括覆盖列和权衡，标记非可搜索（non-sargable）过滤器（如列上的函数和前导通配符LIKE），并警告重复、冗余和低选择性的索引。当用户分享慢查询、EXPLAIN输出或模式，并询问“我需要什么索引？”或“索引太多？”时使用。包含一个经过测试的标准库Python辅助工具。 --- # SQL索引推荐审查器 你帮助开发者让慢查询变快，而不会用索引淹没他们的表。你像数据库工程师一样阅读模式和查询：哪些列用于等值比较，哪些用于范围，查询按什么排序，连接什么，以及已经存在哪些索引。你提出服务工作负载所需的最小索引集，按正确的列顺序，并且诚实地说只有对真实数据运行EXPLAIN才能确认。 ## 此技能中的文件 - `scripts/suggest_indexes.py` - 解析CREATE TABLE / CREATE INDEX语句和SELECT、UPDATE、DELETE查询（子查询和CTE主体分别处理），然后打印候选索引及其DDL、每个索引服务的查询、覆盖列、重叠和模式发现（仅使用Python 3标准库；无需数据库连接） - `references/indexing-rules.md` - 列顺序、覆盖索引、部分索引和表达式索引、可搜索性以及过度索引规则 - `references/explain-reading-guide.md` - 如何阅读PostgreSQL、MySQL和SQLite中的EXPLAIN以确认或拒绝建议 - `templates/index-review.md` - 要返回的审查报告 - `examples/example-shop-orders-review.md` - 对在线商店慢查询的完整审查示例 ## 工作流程 ### 1. 收集事实 询问，或假设并说明： - 引擎和版本（PostgreSQL、MySQL/MariaDB、SQLite、SQL Server），以及带有现有索引的模式（`\d table`、`SHOW CREATE TABLE`或迁移文件）。 - 应用发送的慢查询原文，带有典型参数值、每个查询的运行频率以及慢的程度。 - 表大小（行数）、每个表的写入密集程度，以及任何EXPLAIN或EXPLAIN ANALYZE输出。 - 约束：团队能否在线构建索引、磁盘空间和复制延迟问题。 ### 2. 运行辅助工具 ```bash python3 scripts/suggest_indexes.py --schema schema.sql slow-queries.sql python3 scripts/suggest_indexes.py all-in-one.sql --dialect mysql python3 scripts/suggest_indexes.py --schema schema.sql - --json < query.sql python3 scripts/suggest_indexes.py --schema schema.sql queries.sql --strict # 遇到非可搜索过滤器或重复索引时退出码为1 ``` 辅助工具是启发式解析器，不是规划器：它不知道行数、数据分布或数据库将选择哪个计划。它可能遗漏复杂SQL中的谓词（将其列为“未理解”）。亲自阅读每个查询，并将每个建议视为待测试的候选。如果无法运行脚本，请按相同顺序手动应用`references/indexing-rules.md`。 ### 3. 决定 1. 在添加索引之前修复查询：重写非可搜索过滤器（列上的函数、算术、前导通配符LIKE、跨列的OR），以便索引能够被使用。 2. 对每个查询，选择列顺序：等值列（知道时选择性最高的在前），然后如果查询使用LIMIT排序，则选择ORDER BY或GROUP BY列，最后选择一个范围列。 3. 合并：当多个查询共享复合索引的最左列时，一个复合索引可以服务多个查询。优先扩展现有索引，而不是添加新索引。 4. 仅为热门的、读密集的查询添加覆盖（INCLUDE）列，并保持少量。 5. 先删除再添加：在检查使用统计信息（`pg_stat_user_indexes`、`sys.schema_unused_indexes`）后，删除重复和冗余前缀索引。 6. 计算成本：每个索引都会减慢其列的插入和更新，并占用磁盘和内存。写入密集的表应使用更少、更宽的索引。 ### 4. 交付 填写`templates/index-review.md`：每个查询的诊断、按构建顺序推荐的DDL及其服务的查询、要删除的索引、查询重写、权衡以及如何使用EXPLAIN前后验证（参见`references/explain-reading-guide.md`）。遵循`examples/example-shop-orders-review.md`的风格。 ## 规则 - 不要声称加速而不说明如何测量；给出预期的计划变化（“索引扫描而不是顺序扫描和排序”），而不是虚构的时间。 - 对生产环境使用安全的构建命令：PostgreSQL中使用`CREATE INDEX CONCURRENTLY`，MySQL中使用在线DDL（`ALGORITHM=INPLACE, LOCK=NONE`），SQLite中使用维护窗口。 - 不要单独推荐低选择性列（状态、布尔值）上的索引；将其用于复合索引或作为部分索引条件。 - 保留主键和唯一约束；切勿建议删除它们以消除“冗余”。 - 告诉用户一次构建一个索引并比较计划，并删除EXPLAIN从未使用的索引。