SQLフォーマッターの整形ルール|改行と大文字化の仕組み

1行に長くつながったSQLを、句ごとに展開して見せてくれるのがSQLフォーマッターです。この記事では、そのフォーマッターがクエリを「どのように」整えるのか、ルールをそのまま説明します。ログやORMの出力からコピーした1行のクエリを、毎回目で追いながら読むのに時間を使っている方に必要な内容です。
要点だけ先に言うと、次のとおりです。フォーマッターはクエリの意味を変えません。空白と改行、そしてキーワードの大文字・小文字だけに手を入れます。
まとめ ① 大文字になるのは、あらかじめ決められたSQLキーワードのリストに含まれる単語だけで、テーブル名・カラム名や引用符で囲んだ文字列は元の大文字・小文字のまま残ります。 ② SELECT・FROM・WHERE・JOIN・GROUP BY・ORDER BY などの主要な句ごとに新しい行が生まれ、AND・OR・ON の条件、カンマの後の項目、サブクエリは一段深くインデントされます。 ③ 変わるのは空白・改行・キーワードの大文字・小文字だけで、クエリの実行上の意味は同じです。
1行に詰まったクエリはなぜ読みにくいのか
アプリケーションのログ、ORMが出力したクエリ、チャットに貼られたクエリは、たいてい改行なしで1行につながっています。select a,b,c from t1 join t2 on ... where ... and ... order by ... のような形です。
この形では、どこがSELECTの項目でどこが条件句なのか、境界が目に入りません。WHEREの後に条件がいくつ付いているかを数えるには、文字列を左から最後までたどる必要があります。
特にサブクエリが入ると、括弧の中がもう一つのSELECTなのか、単なる関数呼び出しなのかが混ざって見えます。この境界を毎回頭の中で描き直すことが、疲れの原因になります。
ツールを使わずに自分で整えるルール
フォーマッターがやっていることは、決まった機械的なルールの繰り返しです。だからツールなしでも、手で同じことができます。手順は次のとおりです。
1. キーワードだけを大文字にする。 SELECT・FROM・WHERE・JOIN・AND・ON・GROUP BY・ORDER BY のような予約語だけを大文字にします。テーブル名、カラム名、関数の引数、引用符で囲んだ文字列には手を付けません。
2. 主要な句ごとに改行する。 SELECT・FROM・WHERE・HAVING・LIMIT・GROUP BY・ORDER BY、そしてJOIN系(LEFT JOIN、INNER JOIN など)が出てくるたびに、新しい行から始めます。
3. 条件と項目を一段深くする。 AND・OR・ON で始まる条件、カンマの後に続くSELECTの項目は、句より一段内側に入れます。
4. サブクエリの括弧はさらに深く、関数の括弧は名前につけたまま。 括弧の中がもう一つのSELECTなら、その内側をさらに一段深くします。一方、COUNT(*) のような関数呼び出しの括弧は名前に付けたままにします。
この4つのルールを、次の1行のクエリに当てはめます。
select o.id, o.total, u.name from orders o join users u on u.id = o.user_id where o.total > 1000 and u.status = 'active' order by o.total desc;
ルールどおりに整えると、こうなります(インデントは2スペースの場合)。
SELECT o.id,
o.total,
u.name
FROM orders o
JOIN users u
ON u.id = o.user_id
WHERE o.total > 1000
AND u.status = 'active'
ORDER BY o.total DESC;
ここで確認しておきたい点がいくつかあります。'active' の文字列は大文字になっていませんし、別名の o・u とカラム名も小文字の元のままです。大文字になったのは SELECT・FROM・JOIN・ON・WHERE・AND・ORDER BY・DESC のような予約語だけです。
手でもできますが、条件が10個も付いたりサブクエリが入れ子になったりすると、括弧の深さを数えるところから面倒になります。無料のSQL フォーマッターで確認してみてください。
貼り付けるだけで予約語の大文字化と句ごとの改行が行われ、整列されます。インストールや会員登録なしで、ブラウザ上ですぐに実行できます。

整形された結果をどう読めばいいのか
整形結果を見るときに覚えておきたいのは、「形だけが変わった」という点です。行が複数に増えたからといって、クエリが変わったわけではありません。
インデントが一段深くなった行は、すぐ上の句に属する部分という意味です。WHEREの下でインデントされたANDはそのWHEREの追加条件で、開き括弧の後でさらに深く入ったSELECTはサブクエリです。
サブクエリの括弧は深さを一段増やしますが、関数呼び出しの括弧はそのまま名前に付いているので、インデントの深さをたどるだけで「この括弧が副問い合わせなのか単なる関数なのか」を目で見分けられます。
画面には結果とあわせて、出力行数と出力サイズ(バイト)の2つの値が表示されます。この数値は整形後のテキストの長さを表すだけで、クエリの性能や処理する行数とは何の関係もありません。
よくある誤解
いちばん多い誤解は、「整形するとクエリの結果が変わる」というものです。フォーマットは空白・改行・キーワードの大文字・小文字だけを変えるので、データベースが読む意味は同じです。
ひとつの限界もあわせて知っておくとよいでしょう。SQLはMySQL・PostgreSQL・Oracle などの方言ごとに細かい構文が異なり、フォーマッターが把握しているキーワードリストにない特殊な構文は句として認識されず、整形が不自然につながることがあります。つまりこのツールは、可読性を高めるための参考用だということです。
| よくある誤解 | 実際の動作 |
|---|---|
| 整形するとクエリの結果が変わる | 空白・改行・キーワードの大文字・小文字だけが変わり、実行上の意味は同じです |
| 大文字になった単語はすべて予約語だ | あらかじめ定義されたキーワードリストに含まれる単語だけが大文字になります |
| カラム名・テーブル名も大文字に統一される | 識別子と引用符で囲んだ文字列は元の大文字・小文字を維持します |
| すべての括弧がインデントを生む | サブクエリの括弧だけがインデントされ、関数呼び出しの括弧は名前に付いたままです |
| インデントを変えるとクエリも変わる | 2スペース・4スペース・タブは見た目の余白が違うだけで、意味は同じです |
まとめ
- 大文字化は決められたキーワードリストにだけ適用され、テーブル名・カラム名や引用符で囲んだ文字列は元のまま維持されます。
- SELECT・FROM・WHERE・JOIN・GROUP BY・ORDER BY のような主要な句ごとに新しい行が生まれ、AND・OR・ON の条件やカンマの後の項目は一段深く書かれます。
- サブクエリの括弧はインデントを増やしますが、関数呼び出しの括弧は名前に付いているので、深さを見るだけで両者を区別できます。
- コメントと文字列はそのまま保持され、セミコロンで区切られた複数の文をそれぞれ整形します。
- 変わるのは形だけなので実行上の意味は同じで、インデントの単位(2・4スペース・タブ)を変えても意味は変わりません。
貼り付けるだけで予約語の大文字化と句ごとの改行が行われ、整列されます。インストールや会員登録なしで、ブラウザ上ですぐに実行できます。
よくある質問
整形するとクエリの実行結果は変わりますか?
変わりません。フォーマットは空白・改行・キーワードの大文字・小文字だけを調整するので、データベースが解釈するクエリの意味はそのままです。ただし方言ごとの特殊な構文は整形が不自然になることがあるため、可読性向上のための参考ツールとお考えください。
カラム名や文字列も大文字になりますか?
いいえ。大文字化は SELECT・FROM・WHERE・JOIN のようなあらかじめ定義されたキーワードリストに含まれる単語にだけ適用されます。テーブル名・カラム名、関数の引数、引用符で囲んだ文字列リテラルは元の大文字・小文字を維持します。「キーワードを大文字化」のチェックボックスをオフにすると、予約語も元のままになります。
複数の文を一度に整形できますか?
はい。セミコロン(;)で区切られた複数の文をそれぞれ整形します。各文はセミコロンで区切られ、独立して句ごとの改行が適用されます。コメント(-- 、/* */)と文字列の中身は、整形の過程でもそのまま保持されます。
インデントを2スペースから4スペースに変えると何が違うのですか?
インデントされた行の前の余白の幅だけが変わります。スペース2つ、スペース4つ、タブの中から選べ、どれを選んでも行が分かれる位置やクエリの意味は同じです。設定を変えると、別途実行ボタンを押さなくても結果がすぐに再計算されます。
この記事は韓国語の原文をもとに作成しています。 韓国語の原文を読む