SQL フォーマッター

実装済み

意味を変えずにクエリを整えます。フォーマッターはあえて慎重に作られています。

フォーマッターは設定できますが、意図的に慎重な作りです。SQLly 再度字句解析し、出力をトークン単位で比較します 出力を入力と照合し、一致しなければ SQL には一切手を加えません。コメントやリテラルを危険にさらさずに、再インデント、キーワードの大文字小文字の統一、句の整列ができます。

SQL のフォーマット

押す ⌥⇧F (Alt+Shift+F Windows と Linux では)、次を選択します 編集 › ドキュメントのフォーマット、または右クリック › ドキュメントのフォーマット 選択範囲に関係なくクエリ全体をフォーマットします。選択範囲だけをフォーマットするには、次を押します ⌘K ⌘F (Ctrl+K Ctrl+F) のための 選択範囲のフォーマット。どちらのショートカットも次で変更できます 設定 › ワークスペース › キーボードショートカット。次を選ぶこともできます クエリ › SQL のフォーマット、ツールバーのボタンを使うか、コマンドパレットから実行します。テキストを選択している場合は選択範囲のみが整形され、選択していない場合はクエリ全体が整形されます。デフォルト設定で 1 行のクエリを整形すると次のようになります:

-- before
select o.OrderId, c.Name, sum(l.Qty * l.Price) as total from dbo.Orders o join dbo.Customers c on c.Id = o.CustomerId left join dbo.OrderLines l on l.OrderId = o.OrderId where o.Status = 'open' and o.Total > 100 group by o.OrderId, c.Name order by total desc

-- after
SELECT
    o.OrderId,
    c.Name,
    SUM(l.Qty * l.Price) AS total
FROM
    dbo.Orders o
    JOIN dbo.Customers c ON c.Id = o.CustomerId
    LEFT JOIN dbo.OrderLines l ON l.OrderId = o.OrderId
WHERE
    o.Status = 'open'
    AND o.Total > 100
GROUP BY
    o.OrderId,
    c.Name
ORDER BY
    total DESC

キーワードと関数は大文字になり、主要な句ごとに改行され、SELECT リストは 1 行に 1 列ずつ縦に並び、次の後のテーブルは FROM (それらの JOIN)と、その後の WHERE そして HAVING それぞれインデントされた独立した行に置かれ、 AND/OR で行が始まります。80 文字に収まる単一のステートメントは 1 行のままです: SELECT id, name FROM dbo.Users WHERE id = 1。インデントは、別途指定しない限り、エディターのタブ設定に従います。

SQLly
SQL の書式設定後に、複数の結合を含む Orders クエリを表示しているエディター。キーワードは大文字になり、各句は別々の行に配置されています。SQL の書式設定後に、複数の結合を含む Orders クエリを表示しているエディター。キーワードは大文字になり、各句は別々の行に配置されています。
「SQL を整形」後の、1 行だった複数結合クエリ。キーワードは大文字、1 行に 1 列、句の位置は揃えられています。

作業しながらフォーマット

その 作業しながらフォーマット の上部にあるトグル 設定 › エディター › フォーマット 入力中にフォーマットします。オンにすると、次を押すと Enter 入力中のステートメントを再フォーマットし、キャレットは以前と同じ文字の直後に留まるため、そのまま入力を続けられます。既定ではオフです。オフの場合、随時フォーマットするには「ドキュメントのフォーマット」(⌥⇧F macOS で、 Alt+Shift+F Windows と Linux では、次で再割り当てできます 設定 › ワークスペース › キーボードショートカット).

次の場合、Enter を押してもテキストは変更されません:

  • テキストが選択されているか、複数のカーソルで編集しているか。
  • このタブは Redis 接続上にあり、そのエディターが保持するのは SQL ではなくコマンドです。
  • ステートメントがステートメントキーワードで始まっていません: SELECT, INSERT, UPDATE, DELETE, WITH, CREATE, ALTER, DROP, MERGE, TRUNCATE, GRANT, REVOKE, BEGIN, DECLARE、または EXEC.

スクリプトと GO バッチ

複数のステートメントを含むスクリプトは、1 ステートメントずつ、それぞれ新しい行から始まる形で整形されます。1 行にまとめるショートカットは、テキスト全体が単一のステートメントである場合にのみ適用されます。ステートメントは次で終わります ; 、そしてSQL Serverではさらに GO バッチ区切り文字。 GO 常に独立した行のままで、他のキーワードと同じ大文字小文字で表記され、繰り返し回数が付いていても同様です(GO 5)、または同じ行にあるコメント:

-- before
select 1
go
select name from dbo.Users
go

-- after
SELECT
    1
GO
SELECT
    name
FROM dbo.Users
GO

GO 行に任意の件数またはコメントのみが書かれている場合にのみ区切りとして扱われ、ステートメントの間にあります。 sqlcmd およびSSMSが想定するとおりです。名前が付いた列は go を SELECT リストの途中で [go]、そして go 文字列やコメントの中にあるものは、そのまま通常の SQL として残ります。方言が自動検出のとき、 GO 行は、スクリプトを SQL Server としてマークします。方言が別のエンジンに設定されている場合、 GO は区切り文字ではありません。

設定

すべては次の中にあります 設定 › エディター › フォーマット、ライブプレビューがあり、自分の SQL を貼り付けて、設定を変えるとどう変わるかを確認できます。最も手早い始め方は プリセット:

プリセットスタイル
デフォルト上に示したレイアウト。
コンパクト短い句と選択リストは1行にまとめて表示され、 AND/OR が行末に付きます。
展開済み先頭カンマ、主要な句の前の空行、 ON 独立した行に置き、演算子、データ型、エイリアスを揃えます。
キーワードを大文字にする / キーワードを小文字にするキーワードと関数をその大文字/小文字にする、既定のレイアウト。
既存を保持大文字・小文字、カンマ、句の配置は維持し、残りを整えます。

プリセットを選択すると、すべてのレイアウト設定が書き換えられますが、書式トリガーは維持されます(作業しながらフォーマット, 保存時にフォーマット、そして 貼り付け時にフォーマット)。そのため、別のプリセットを試してもオフに切り替わらなくなります。その後で個々の設定を 1 つでも変更すると、その設定は次に切り替わります カスタム。各セクションでは、キーワードの大文字小文字(全体、またはデータ型や JOIN などグループごと)、識別子の大文字小文字と引用符、句のレイアウト、選択リスト、カンマのスタイル、ブール条件などを設定できます。 CASE、演算子、JOIN、関数、サブクエリと CTE、DML、DDL、コメント、インデント、行の長さ(デフォルトは 120)、ステートメント。次の SQL 方言 設定の既定値は「自動検出」で、SQL 自体から方言を判別します。

保存時にフォーマット そして 貼り付け時にフォーマット は次の下にあります フォーマットトリガー。どちらもデフォルトではオフです。

FROM と WHERE の配置

次の 2 つの設定 句のレイアウト 句の本体をキーワードと同じ行から始めるか、その下のインデントした独立の行から始めるかを選びます:

Option何ができるか
FROM の後のテーブル改行してインデント (デフォルト)は、最初のテーブルを次の下に独立した行で置きます。 FROM、そして次のものをそろえます JOINを揃え、 ON 単独の行に置くと、さらに 1 段インデントされます。 キーワードと同じ行 はテーブルを次に保ちます FROM 行、次とともに JOINの配置を決めるのは、 JOIN のレイアウト 設定。
WHERE / HAVING の後の最初の条件改行してインデント (デフォルト)は、最初の条件を次の下に独立した行で置きます。 WHERE または HAVING、次に揃えられています AND/OR 続く行。 キーワードと同じ行 はキーワードの行に残します。

その コンパクト そして 既存を保持 プリセットでは両方がキーワードと同じ行に残ります。直後に書かれたコメント FROM または WHERE その行に残ります。

CTE、DML、インデックス列

これらのオプションは、よくあるステートメントのパターンをどのように整形するかを制御します:

Option何ができるか
CTE スタイルスタック (デフォルト)は、各 CTE の本体を独立した行に置きます。 インライン 各 CTE の name AS ( … ) 1 行に収めます。次を含む CTE は、 -- コメント、または最大行長を超えてしまう場合は、積み重ねたままになります。
DML スタイル標準 (デフォルト)は、通常のレイアウトです。 コンパクト 次を置きます INSERT, UPDATE, DELETE、または MERGE 最大行長に収まる場合は 1 行にまとめます。 展開済み それぞれを置きます INSERT 列、各 VALUES 項目、およびそれぞれの UPDATE SET 代入は独立した行に置かれ、次によって1行にまとめられることはありません 短いクエリは 1 行にまとめる.
複数行のインデックス列インデックスに複数の列がある場合、各キー列と各 INCLUDE 次の列 CREATE INDEX 独立した行に置かれます。同じことが次にも当てはまります PRIMARY KEY, UNIQUE, INDEX、そして KEY 内部の列リスト CREATE TABLE. FOREIGN KEY 列のリストはそのまま残されます。
末尾コメントを式と一緒に移動する次の設定と組み合わせて動作します インラインコメントをインラインのまま保持する。両方をオンにすると、行末の -- comment フォーマッタがその行を再改行した後も、コードの行末に残ります。

その コンパクト そして 展開済み プリセットはこのグループの対応するオプションをオンにします。次の CREATE INDEX … ON table (…)、テーブル名は大文字小文字が保たれ、キーワードのように大文字に変換されなくなりました。

補完は設定に従います

補完で IntelliSense 候補を受け入れると、SQLly は「SQL のフォーマット」がそのステートメントを整形するのと同じレイアウトで挿入します。キーワードと関数の大文字小文字、識別子の大文字小文字と引用符、 JOIN そして ON 配置、その他のフォーマット設定も尊重されます。たとえば、 ON 句の配置 次に設定 新しい行に、 結合候補 その ON 独立した行に置きます。次に収まる短さのステートメントは 短いクエリは 1 行にまとめる 「SQL のフォーマット」を使った場合と同じように、1 行にとどまります。フォーマッターが結果を入力した内容に合わせられない場合、候補はそのまま挿入されます。

SQL に手を加えない

フォーマッターに一切触ってほしくない領域は、書いたそのまま維持するようマークします:

-- formatter:off
SELECT weird , hand_aligned
       , columns   -- left exactly as typed
FROM t;
-- formatter:on

スイッチはステートメントごとに働きます。次の後に始まるステートメント -- formatter:off はそのまま保持され、その後のステートメントもすべて、次が現れるまで同じ扱いです -- formatter:on。ステートメントの途中にあるマーカーはその一部を保護しないので、ステートメントは次で終えてください ; または GO 行。マーカーは次でオフにできます 制御コメントに従う コメントセクションで。

SQL を壊しません。 トークンチェックにより、書式設定のバグは、壊れた SQL ではなく何も起こらない処理(no-op)になります。終了していない文字列やコメントなど、字句解析できない SQL は、整形し直されず、そのまま返されます。コメントが削除されることはありません。

Redis 接続では SQL のフォーマットは何もしません。エディターが保持するのは SQL ではなくコマンドだからです。

SQLをミニファイ

逆方向では、ログ、JSON ペイロード、コマンドライン向けに 1 行のコンパクトな形にする SQLをミニファイ 通常のコメントを取り除き、すべての空白を 1 つのスペースにまとめます。文字列リテラル、引用符付き識別子、ドル引用符付き本体はそのまま残るため、圧縮された SQL は元の SQL とまったく同じように実行されます。 -- sqlly ディレクティブコメントと /*+ hint */ オプティマイザーヒントは保持され、SQL Server の GO セパレーターはサーバーの要件上、独立した行に置かれます。正しく解析できない SQL は、壊さずそのまま残されます。

コンパクト化する SQL を選択するか、ステートメント内にカーソルを置くか、何も選択せずにクエリ全体を最小化して、 ⌘⌥⇧F (Ctrl+Alt+Shift+F Windows と Linux では)、次を選択します クエリ › SQL の最小化、またはコマンドパレットから実行します。結果は元に戻せる 1 回の編集として反映されるので、1 回の取り消しで整形前の SQL に戻せます。