mcpField
S
sql-writing-style

sql-writing-style

github.com/efoo-team数据与数据库052 次安装1 周前更新
代码仓库

关于 sql-writing-style

指导 Agent 以结构化规则和正反示例编写易读 SQL 的技能,重点是降低查询的理解成本。

主要功能

  1. 01使用易读的表别名
  2. 02统一规则与示例结构
  3. 03SQL 正反对照示例

适用场景

  1. 01检查 SQL 的可读性
  2. 02为易维护的代码库编写查询

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/efoo-team/skills --skill sql-writing-style

安装后在 Claude Code 中输入/sql-writing-style确认已加载。

README 原文English

来自项目 README

README 暂无中文译文,以下为英文原文;中文介绍见上方。

SQL Writing Style

SQLは実行回数より読まれる回数のほうが多い。読み手の認知負荷を最小にする。

各ルールは「見出し(### 採番. ルールの要旨)+1行の理由+bad / good の対比例」で書く。ルールを追加するときはこの節構造を踏襲する。

ルール

1. テーブルエイリアスは全文を使う。無意味な短縮をしない

FROM stores s のような1文字エイリアスで読み手に逆引きを強いるのは避ける。ただし自己結合や、極端に長いテーブル名で全文表記がかえって読みにくくなる場合は、意味が伝わる短縮エイリアスを許す。

-- bad
FROM stores s
JOIN users u ON u.store_id = s.id

-- good
FROM stores
JOIN users ON users.store_id = stores.id

评论

支持 Markdown