「このクエリ、密すぎて読めない……」

運用中のシステムから吐き出された、一行に固まった巨大なSQL。あるいは複雑なJOINが何層にも重なったストアドプロシージャ。「どこで条件が分岐しているの?」と画面を睨みつけたことはありませんか?

SQLフォーマッター は、貼り付けたSQLをブラウザ内で整形するツールです。すべてローカルで処理されるため、機密性の高いクエリでも外部に送信されません。

SQLフォーマッターでクエリを読みやすく整形する方法

Before / After

select users.id,users.name,count(orders.id) from users left join orders on users.id=orders.user_id where users.deleted_at is null group by users.id,users.name order by users.id desc;
SELECT
  users.id,
  users.name,
  COUNT(orders.id)
FROM users
LEFT JOIN orders ON users.id = orders.user_id
WHERE users.deleted_at IS NULL
GROUP BY
  users.id,
  users.name
ORDER BY users.id DESC;

見た目が整うだけで、条件の抜け・JOINの向き・集計単位の誤りに気づきやすくなります。

なぜ「方言(dialect)」の指定が必須なのか

SQLフォーマッターは、入力をトークナイズして構文を理解してから改行やインデントを組み立てます。そのため、SQLの実装ごとの拡張仕様(方言)を知らないと、正しく整形できません。

方言差の例 Standard SQL MySQL PostgreSQL BigQuery
識別子の引用 "name" `name` "name" `project.dataset.table`
文字列連結 || CONCAT() || ||
LIMIT構文 LIMIT n LIMIT n LIMIT n OFFSET m LIMIT n
配列/構造体 非標準 非対応 ARRAY[...] STRUCT<...>

たとえばMySQLのバッククォート識別子を Standard SQL としてパースすると、トークンの境界がズレて整形結果が崩れることがあります。「整形がおかしい」の原因の大半は方言の選択ミスです。ツールでは PostgreSQL / MySQL / MariaDB / SQL Server / BigQuery など主要な方言 を選択でき、方言を切り替えると自動で再整形されます。使用中のデータベースに合わせて選ぶようにしてください。

整形オプションと、テンプレート・ストアドへの対応

SQLフォーマッターには、見た目を整える11のオプションがあります。

オプション 選択肢 効果
キーワードの大文字・小文字 そのまま / 大文字 / 小文字 select を SELECT にそろえるなど
インデント スペース2 / スペース4 / タブ チームの規約に合わせる
AND / OR の位置 行頭 / 行末 条件を足したり消したりするときの差分を小さくしたいなら、行頭が向く
1行の最大幅 狭い(30)/ 50 / 広い(80) 小さいほど縦に長くなり、括弧の中も改行されやすい
関数名の大文字・小文字 そのまま / 大文字 / 小文字 COUNT(*) と count(*) をそろえる。キーワードとは別に指定できる
データ型の大文字・小文字 そのまま / 大文字 / 小文字 VARCHAR(10) と varchar(10) をそろえる
識別子(テーブル・列名)の大文字・小文字 そのまま / 大文字 / 小文字 引用符つき("Name"・`name`)の識別子は変えない
キーワードの揃え方 標準 / 左揃え / 右揃え 左揃え・右揃え(リバー形式)は、SELECT・FROM・WHERE を縦にそろえて、中身を同じ位置から始める
演算子のスペース あり / なし なしにすると a=1、a+b のように詰める
セミコロン 行末 / 単独の行 単独の行にすると、文の最後に ; だけの行が付く
文の間の空行 1 / 2 / 3 複数の文を整形したときの、文と文の間の空行の数

入力した SQL が別の方言の書き方(ON CONFLICT・TOP・AUTO_INCREMENT など)に見えるときは、「この SQL は PostgreSQL の書き方のようです」と、切り替えを提案します。勝手には変えず、標準 SQL にも通じる書き方だけのときは何も出しません。

実務のSQLには、そのままでは構文エラーになる書き方も混ざります。次のものは、中身を崩さずに整形できます。

  • テンプレート変数: dbt や Jinja の {{ ref('orders') }}・{% if … %}・{# … #}、シェルやJSの ${var} は、1つのかたまりとして扱われます
  • SQL Server の GO: 方言に SQL Server(T-SQL)を選ぶと、単独の GO 行でバッチに分けて、バッチごとに整形します。文字列やコメントの中の go は区切りとみなしません
  • MySQL の DELIMITER: DELIMITER // のような行を含むスクリプトも、区切り文字ごとに文を切り出して整形するので、// が割れてしまうことはありません

逆方向の「圧縮」ボタンは、空白・改行・コメントを詰めて1行にします。文字列リテラルの中は変更しません(コメントは削除されます)。ログや設定ファイルに1行で埋め込みたいときに使います。

SQLレビューで見るべきポイント

整形しただけの状態から、さらにレビューの質を上げるための確認項目です。

  • WHERE 条件が意図通りか
  • JOIN の条件が不足していないか
  • LEFT JOIN と INNER JOIN の使い分けが正しいか(SQL JOIN完全リファレンス にJOIN種類ごとの違いをまとめています)
  • GROUP BY の粒度が期待通りか
  • ORDER BY や LIMIT が必要な場面で指定されているか
  • サブクエリやCTEの責務が分かりやすいか

とくにログから拾ったSQLは、プレースホルダーが展開済みで長くなりがちです。整形してから読むだけで調査時間を大きく減らせます。

整形は「見た目」以上の仕事をする

フォーマッターを通す価値は、見た目が整うこと自体よりも副次効果にあります。

  1. 構文エラーの早期発見: パースに失敗する=どこかが壊れている。実行前の簡易チェックになる
  2. 差分レビューが利く: 整形規則を固定すると、クエリ変更のdiffが「実質的な変更」だけになる
  3. ORMの出力の解読: 機械生成の1行SQLは、整形して初めて何をJOINしているかが見える

とくに1つ目は見落とされがちですが、閉じ括弧の数が合わない・カンマが抜けているといったミスは、整形処理がエラーを返すことで気づけます。

整理と埋め込み、別のデータベースへの書き換え

SQLフォーマッターには、整形のほかに、貼った SQL を整える・コードに埋め込む・別のデータベース向けに書き換える機能があります。

整理と埋め込み

  • コメントの除去: -- と /* */ を取り除きます。MySQL の /*! … */ とオプティマイザヒント /*+ … */ は、動作に関わるので残します
  • 識別子の引用符の付け替え: MySQL の `x`・PostgreSQL / SQLite の "x"・SQL Server の [x] を相互に変えます。引用符を外すときは、英小文字・数字・_ だけで、予約語でないものに限ります
  • コード用の文字列にする: JavaScript(テンプレートリテラル)・Python(三重引用符)・Java(テキストブロック)・Go・PHP・C#・JSON の文字列にします
  • コードの文字列から SQL を取り出す: "SELECT … " + "FROM …" のような連結や、\n のエスケープを読んで、SQL に戻します。ログやソースからのコピーを、そのまま整形にかけられます

別のデータベースへの書き換え

MySQL・PostgreSQL・SQLite・SQL Server の間で、機械的に直せる部分を書き換えます。文字列・コメント・識別子の中は触りません。

項目 例
識別子の引用符 `id` → "id" → [id]
件数の制限 LIMIT 10, 5 → LIMIT 5 OFFSET 10。SQL Server へは TOP (n) / OFFSET … FETCH
NULL の置き換え IFNULL(a, 0)・ISNULL(a, 0) ⇄ COALESCE(a, 0)
現在時刻 NOW() ⇄ GETDATE() ⇄ CURRENT_TIMESTAMP
文字列の集約 GROUP_CONCAT(x SEPARATOR ',') ⇄ STRING_AGG(x, ',')
キャスト a::int → CAST(a AS int)
型・自動採番(CREATE TABLE) AUTO_INCREMENT ⇄ SERIAL ⇄ IDENTITY(1,1)、TINYINT(1) → BOOLEAN、DATETIME → TIMESTAMP など

機械的に直せないものは、書き換えずに「手で確認すること」として一覧に出します。ILIKE(LIKE に変えたうえで、大文字小文字の扱いの違いを注意)・||(MySQL では OR の意味)・RETURNING・UPSERT(ON CONFLICT と ON DUPLICATE KEY UPDATE など)・ORDER BY つきの GROUP_CONCAT・MySQL のバックスラッシュのエスケープなどです。結果は出発点です。方言ごとの意味の違いは多いので、必ず実際のデータベースで試してください。

よくある質問

MySQLやPostgreSQLのSQLに対応していますか?

はい。主要なSQL方言(Standard SQL / MySQL / PostgreSQL / MariaDB / SQL Server / BigQueryなど)に合わせて整形できます。方言固有の構文が含まれる場合は、整形後に実行前の確認を行ってください。

整形するとSQLの意味は変わりますか?

通常、整形は空白・改行・インデント・大文字小文字を調整する処理で、クエリの意味(実行結果)は変わりません。ただし実行前には、必ず元のSQLと意図が変わっていないか確認するのが安全です。

方言を間違えて選ぶとどうなりますか?

識別子の引用符やキーワードの解釈がズレるため、インデントが崩れたり、意図しない位置で改行されたりすることがあります。「整形結果がおかしい」と感じたら、まず方言の選択を見直してください。

機密データを含むSQLを貼っても大丈夫ですか?

はい。整形はすべてブラウザ内で完結し、ネットワーク通信は発生しません。テーブル名やカラム名を含むクエリでも、外部に送信されることなく処理されます。

MySQLのSQLをPostgreSQLやSQL Server用に変換できますか?

引用符・LIMIT・IFNULL / COALESCE・NOW()・GROUP_CONCAT / STRING_AGG・:: のキャスト・CREATE TABLE の型や AUTO_INCREMENT など、機械的に直せる部分は書き換えます。ILIKE・||・UPSERT・RETURNING のように、意味が変わるものは書き換えず、手で確認する項目として一覧にします。同じ結果になることは保証しないので、実行前に実際のデータベースで確認してください。

まとめ

  • SQLフォーマッターの本体はライブラリへの1行の委譲だが、方言指定が結果を左右する本質的なパラメータ
  • 識別子の引用符ひとつでパースが変わるため、使用中のDBに合わせて方言を選ぶ
  • 整形は見た目のためだけでなく、構文エラーの早期発見・diffの安定化・機械生成SQLの解読に効く

ログから拾ったクエリの解読に、ぜひ使ってみてください。