SQLフォーマッター

SQLの構造を読み取りやすく整える

SQLフォーマッターは、入力したSQLテキストの空白、改行、字下げ、認識されたキーワードの大文字・小文字を整えるツールです。1行に詰まったSELECT文も、SELECT、FROM、JOIN、WHERE、ORDER BYなどのまとまりを追いやすい形にできます。データベースへ接続して文を実行したり、表や列の定義を調べたりする機能ではありません。また、条件式や結合条件の意味を判断して書き換えるものでもありません。

「キーワード」はSELECTやWHEREのようにSQLの構文で役割を持つ語、「識別子」は表名や列名などの名前です。キーワードの表記をUpper／Lowerにしても、SQL本文全体を単純に大文字・小文字へ変換するわけではありません。文字列や識別子の引用符はデータベースごとに扱いが異なるため、対象の方言を選んでから結果を確認してください。

方言と書式設定の選び方

方言によって、予約語と名前の境界や引用符の意味が違います。たとえばPostgreSQLでは二重引用符で囲まれた名前は引用識別子として扱われ、MySQLでは予約語を名前に使う際に引用が必要になる場合があります。書式を揃える目的でも、引用符を含む文は元の意図を保てているか確認しましょう。PostgreSQLの字句構造、MySQLの予約語、SQLiteのキーワードも参照できます。

入力から持ち出しまで

1. 対象の方言を指定する

   Standard SQL、MySQL、PostgreSQL、MariaDB、SQLiteから、SQLを使う環境に合うものを選びます。方言が不明なときは、先に接続先の設定やクエリの作成元を確認してください。

2. SQLを入力する

   入力欄にテキストを貼り付けます。「例」からサンプルを読み込んで、各設定の違いを確かめることもできます。入力や選択を変えると結果が更新されます。

3. チームの書式に合わせる

   インデント幅とスペース／タブ、キーワード表記を選びます。Preserveはキーワードの表記をできるだけ保つ設定で、改行や空白まで元どおりに固定する設定ではありません。

4. 結果を比較して保存する

   入力と出力を見比べ、引用符、文字列、コメント、プレースホルダー、WHEREやJOINの条件が意図したままか確認します。必要なら結果をコピーするか、formatted.sqlとしてダウンロードします。

たとえば、SELECT id,name FROM users WHERE active=1;のような短いSQLも、句の区切りや空白を見やすく整理できます。具体的な改行位置はSQLの構造や選択した方言によって変わるため、出力をそのまま実行可能な完成文とみなさず、元のテキストと照合してください。

出力を使う前に知りたいこと

実行前に元の条件を確認する

SQLの整形は、構文検証、実行、レビュー、性能分析の代わりにはなりません。出力をデータベースで使う前に、必ず元のSQLと照合してください。

• 特にUPDATE、DELETE、DROP、ALTERなどデータや構造を変更する文は、書式が整ったことだけを根拠に実行しないでください。対象、条件、トランザクションを別途確認します。
• 方言固有の関数や構文、ストアドプログラム、動的SQL、テンプレート変数などは、期待どおりに整形されない場合があります。
• 引用識別子と文字列リテラルは別の意味を持ちます。引用符を含む文、コメント、エスケープ、プレースホルダーを重点的に見直してください。
• 認証情報、個人情報、社内ホスト名などを含むSQLは、入力前に不要な値を伏せるか、組織の情報管理ルールに従ってください。