← Back to Skills Marketplace
shenghoo123-png

sql-explain

by shenghoo123-png · GitHub ↗ · v1.0.0 · MIT-0
cross-platform ✓ Security Clean
112
Downloads
0
Stars
0
Active Installs
1
Versions
Install in OpenClaw
/install sql-explain-kay
Description
解析并解读 PostgreSQL、MySQL、SQLite 的 SQL 执行计划,提供性能问题识别与优化建议。
README (SKILL.md)

SQL Query Explain / SQL解释器

身份与目标

你是 SQL Expert,专门帮助开发者理解和优化 SQL 查询。

触发词

  • "explain sql"
  • "sql解释"
  • "分析sql"
  • "sql优化建议"
  • "这个sql怎么写"
  • "sql query explanation"
  • "explain this query"

核心功能

1. SQL EXPLAIN 解析

使用 sqleanexplain 模块(或 Python sqlparse + 内置规则)分析 SQL 查询的执行计划。

支持的数据库: PostgreSQL, MySQL, SQLite, MySQL兼容

分析维度:

  • 表扫描方式(Seq Scan / Index Scan / Index Only Scan / Full Table Scan)
  • 索引使用情况
  • 连接类型(Hash Join / Nested Loop / Merge Join)
  • 估计行数 vs 实际行数
  • 昂贵操作识别
  • 优化建议

2. 自然语言转 SQL

根据用户描述的业务需求,生成标准 SQL。 支持:SELECT / INSERT / UPDATE / DELETE / CREATE TABLE

3. SQL 格式化

输入凌乱的 SQL,输出格式化的结果。 支持关键字大写、缩进、分行。

4. SQL 语法检查

检查 SQL 语法错误,提供修正建议。


工作流程

  1. 识别意图: 判断是解释/生成/格式化/检查
  2. 解析SQL: 使用 sqlparse 解析语法树
  3. 执行分析: 对 EXPLAIN 输出进行结构化分析
  4. 输出结果: 结构化报告 + 优化建议

输出格式

EXPLAIN 解析结果

📊 查询计划分析

🎯 总成本: {cost}
📦 预计返回: {estimated_rows} 行

🔍 扫描分析:
  - 类型: {scan_type}
  - 表: {table}
  - 条件: {conditions}

⚠️ 性能关注点:
  - {issue_1}
  - {issue_2}

💡 优化建议:
  1. {suggestion_1}
  2. {suggestion_2}

定价

  • Free: 10次/天
  • Pro (¥19/月): 100次/天,保存历史记录
  • Team (¥49/月): 无限制,团队共享

技术实现

  • Python + sqlparse(SQL解析)
  • Python 内置规则库(EXPLAIN计划解读)
  • 无外部API依赖,完全本地运行
  • 支持 PostgreSQL / MySQL / SQLite EXPLAIN格式

限制

  • 暂不支持复杂存储过程
  • 暂不支持 DDL 语句的 EXPLAIN
Usage Guidance
This skill appears to be a local, coherent SQL explain/format/check tool. Before installing or running: (1) verify the source (the README's curl URL is a placeholder—avoid running downloaded scripts from unknown repos), (2) prefer installing the dependency via pip (pip install sqlparse) and review sql_explain.py if you plan to run it, (3) run the included tests (pytest) in a sandbox to confirm behavior, and (4) note minor documentation mismatches (references to 'sqlean' and an "AI API" in docs) — these are likely harmless but worth clarifying with the publisher if you need certainty. No credentials or network access are required by the code as provided.
Capability Analysis
Type: OpenClaw Skill Name: sql-explain-kay Version: 1.0.0 The skill bundle provides a set of local tools for SQL formatting, syntax checking, and execution plan analysis using the 'sqlparse' library. The code in 'sql_explain.py' and 'cli.py' is well-structured, lacks any network or sensitive file system access, and contains no evidence of malicious intent or prompt injection vulnerabilities.
Capability Assessment
Purpose & Capability
Name/description match the provided code and SKILL.md. The code implements formatting, basic syntax checks, structure analysis, NL->SQL templates, and parsing of EXPLAIN output using sqlparse and regex — all coherent with 'sql-explain'. No unrelated environment variables, binaries, or cloud credentials are requested.
Instruction Scope
SKILL.md and README keep scope to parsing/analysis/formatting/generation of SQL and EXPLAIN outputs. Minor inconsistencies: SKILL.md mentions using the 'sqlean' explain module OR sqlparse+rules, but the included code uses only sqlparse/regex. README also contrasts an "AI Skill" that may rely on an AI API with the local CLI, yet the skill declares no external API keys; these are documentation mismatches rather than evidence of out-of-scope behavior. The runtime instructions do not tell the agent to read unrelated files, env vars, or transmit data externally.
Install Mechanism
No install spec in the registry; the package is instruction-only for the agent and the repository provides Python scripts. The README suggests pip install sqlparse or curling a raw GitHub file (a placeholder URL). No automated remote downloads or obscure URLs are included in the skill metadata/install spec.
Credentials
The skill declares no required environment variables, no credentials, and no config paths. The code does not read environment variables or attempt to access external secrets; requested resources are proportional to a local parsing/analysis tool.
Persistence & Privilege
always is false and the skill does not request persistent system-level presence. The CLI optionally suggests creating a symlink for convenience, but there is no code that modifies other skills, system-wide agent settings, or stores cross-skill credentials.
How to Use
  1. Make sure OpenClaw is installed (local or Docker)
  2. Run the install command in chat: /install sql-explain-kay
  3. After installation, invoke the skill by name or use /sql-explain-kay
  4. Provide required inputs per the skill's parameter spec and get structured output
Version History
v1.0.0
Initial release
Metadata
Slug sql-explain-kay
Version 1.0.0
License MIT-0
All-time Installs 0
Active Installs 0
Total Versions 1
Frequently Asked Questions

What is sql-explain?

解析并解读 PostgreSQL、MySQL、SQLite 的 SQL 执行计划,提供性能问题识别与优化建议。 It is an AI Agent Skill for Claude Code / OpenClaw, with 112 downloads so far.

How do I install sql-explain?

Run "/install sql-explain-kay" in the OpenClaw or Claude Code chat to install it in one step — no extra setup required.

Is sql-explain free?

Yes, sql-explain is completely free, licensed under MIT-0. You can download, install and use it at no cost.

Which platforms does sql-explain support?

sql-explain is cross-platform and runs anywhere OpenClaw / Claude Code is available (cross-platform).

Who created sql-explain?

It is built and maintained by shenghoo123-png (@shenghoo123-png); the current version is v1.0.0.

💬 Comments