SQL フォーマットガイド
このページはまだ日本語に翻訳されていないため、英語で表示しています。
読みやすく、レビューしやすく、保守しやすい SQL を書くための実践ガイドです。スタイル規約、複雑なクエリ、チームでのワークフロー、方言の違いを取り上げます。各ページの整形例はすべて SQL Format のエンジン自体で生成したものです。
- SQL スタイルガイド 命名、キーワードの大文字・小文字、インデント、エイリアス、明示的な JOIN、コメント、CTE:チームが実際に守り続けられる実用的な規約。
- 複雑な SQL クエリの整形方法 CTE、ネストしたサブクエリ、CASE、ウィンドウ関数、UNION:1 画面以上に及ぶクエリのレイアウト方法。
- SQL の行頭カンマと行末カンマ 2 つのカンマスタイルを詳しく比較:差分、列のコメントアウト、目での追いやすさ、各スタイルが防ぐエラー。
- コードレビューとバージョン管理のための SQL 整形 一貫した整形で差分をきれいに保つ方法、チーム標準の導入方法、プルリクエストでの SQL のレビュー方法。
- SQL の読みやすさを損なうよくある間違い 暗黙の結合、SELECT *、1 文字のエイリアス、AND/OR の混在など、SQL を読みにくくするよくある習慣とその直し方。
- PostgreSQL クエリと PL/pgSQL の整形 キャスト、パラメーター、RETURNING、ON CONFLICT、ドル引用符で囲んだ PL/pgSQL 本体:PostgreSQL 構文に対するフォーマッターの動作。
- 整形に影響する SQL 方言の違い 主要データベースにおける識別子の引用符、LIMIT・FETCH FIRST・TOP、バッチ区切り、手続き型ブロック。
- マイグレーションのデプロイ前の SQL 整形チェックリスト スキーマやデータのマイグレーションをレビューと本番環境に出す前に確認する短いチェックリスト。