SQL 格式化工具

功能性的

整理查詢但不改變它的意思。格式化工具是刻意保守的。

格式化工具可以設定,但刻意保持謹慎。SQLly 重新做語彙分析,並逐個語彙基元比較其輸出 與輸入;任何不符合都不會改動你的 SQL。它可以重新縮排、重新調整關鍵字大小寫,並對齊子句,而不會冒險改動註解或字面值。

格式化 SQL

按 ⌥⇧F (Alt+Shift+F 在 Windows 和 Linux 上)則會把它從查詢中移除。 編輯 › 格式化文件,或者右鍵點擊 › 格式化文件 就會格式化整個查詢,無論選取了什麼。若只想格式化選取範圍,請按 ⌘K ⌘F (Ctrl+K Ctrl+F)用於 格式化選取範圍。這兩個快速鍵都可以在 設定 › 工作區 › 鍵盤快速鍵. 你也可以選擇 查詢 › 格式化 SQL,使用工具列按鈕,或從命令面板執行:有選取文字時,只會格式化選取的部分;否則格式化整個查詢。以下是一行查詢套用預設設定的樣子:

-- 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 清單每欄一行堆疊,而 FROM (連同其 JOIN)以及 WHERE 和 HAVING 各自位於縮排行上,且 AND/OR 會各自領頭佔行。塞得進 80 個字元的單一陳述式會保持在一行: SELECT id, name FROM dbo.Users WHERE id = 1。縮排依你的編輯器 Tab 設定,除非你另外選擇。

SQLly
編輯器在格式化 SQL 後顯示一個多重聯結的 Orders 查詢,關鍵字大寫並且子句分行顯示編輯器在格式化 SQL 後顯示一個多重聯結的 Orders 查詢,關鍵字大寫並且子句分行顯示
格式化 SQL 後原本一行的多重聯結查詢:關鍵字大寫,每行一個欄位,子句對齊。

即時格式化

這 即時格式化 切換開關位於 設定 › 編輯器 › 格式化 會在你輸入時進行格式化。啟用後,按下 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 批次

含有多個陳述式的腳本會一次格式化一個陳述式,每個陳述式單獨一行,單行捷徑只在整段文字是單一陳述式時適用。陳述式以 ; ,對 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 位於選取清單中間, [go],而且 go 在字串或註解內的部分都會視為普通 SQL。當方言設為自動偵測時, GO 行會將腳本標記為 SQL Server。當方言設為其他引擎時, GO 不是分隔符號。

設定

所有內容都存在於 設定 › 編輯器 › 格式化,還有即時預覽:貼上你自己的 SQL,邊調設定邊看它變化。最快的入門方式是 預設集:

預設集樣式
預設如上所示的版面配置。
緊湊簡短的子句和 SELECT 清單保持在同一行,並且 AND/OR 會留在各行尾端。
展開前置逗號、主要子句前空一行, ON 單獨一行,並對齊運算子、資料型別和別名。
大寫關鍵字 / 關鍵字使用小寫關鍵字與函式採用該大小寫的預設版面。
保留現有保留你的大小寫、逗號和子句位置,其餘的由它整理。

選擇預設集會覆寫所有版面配置設定,但保留你的格式觸發器(即時格式化, 儲存時格式化,而且 貼上時格式化),所以改試其他預設組合也不會再把它們關掉。之後只要單獨更改任何一項設定,它就會切換為 自訂。各區段涵蓋關鍵字大小寫(整體或分組設定,例如資料類型或 JOIN)、識別碼大小寫與引號、子句排版、選取清單、逗號風格、布林條件, CASE,可以選擇先接一個 SQL 方言 設定預設為自動偵測,它會從 SQL 本身判斷方言。

儲存時格式化 和 貼上時格式化 則位於 格式化觸發時機。兩者預設都是關閉的。

FROM 和 WHERE 的位置

兩個設定位於 子句佈局 選擇子句的主體是從關鍵字所在的行開始還是從其下方單獨縮排的一行開始:

選項其作用
FROM 後的資料表新的一行,縮排 (預設)會把第一個資料表獨立成一行,放在之後的 FROM,並讓它的 JOIN與其對齊;一個 ON 獨立一行時會再多縮排一層。 與關鍵字在同一行 會把資料表留在 FROM 線,與 JOIN的擺放位置由 JOIN 排版 設定。
WHERE / HAVING 後的第一個條件新的一行,縮排 (預設)會把第一個條件獨立成一行,放在之後的 WHERE 或 HAVING,與 AND/OR 後面那幾行。 與關鍵字在同一行 將其保留在關鍵字所在的行上。

這 緊湊 和 保留現有 預設集會把兩者留在關鍵字同一行。緊接在 FROM 或 WHERE 之後立即撰寫的註解會保留在該行上。

CTE、DML 與索引欄位

這些選項控制常見陳述式形態的版面配置方式:

選項其作用
CTE 風格堆疊 (預設)將每個 CTE 的內容放在獨立行上。 行內 將每個 CTE 的 name AS ( … ) 放在同一行上。包含 -- 註解,或者超過最大行長的,會保持堆疊狀態。
DML 風格標準 (預設)是一般的版面配置。 緊湊 會放入一個 INSERT, UPDATE, DELETE,或 MERGE 當符合最大行長時,放在同一行。 展開 會將每個 INSERT 欄位,每個 VALUES 項目,而每一個 UPDATE SET 指派會獨立成行,而且永遠不會被 讓簡短查詢保持在同一行.
多行索引欄位當索引有超過一個欄位時,每個鍵欄位以及每個 INCLUDE 欄位,屬於 CREATE INDEX 會獨立一行。同樣的規則也適用於 PRIMARY KEY, UNIQUE, INDEX,而且 KEY 欄位清單內部 CREATE TABLE. FOREIGN KEY 欄位清單保持原樣。
將尾端註解隨運算式移動搭配 讓行內註解維持在行內。兩者同時啟用時,換行符 -- comment 在格式化工具重新斷行後,仍留在該行程式碼的尾端。

這 緊湊 和 展開 預設集會開啟此群組中對應的選項。在 CREATE INDEX … ON table (…),資料表名稱會保留原本的大小寫;不會再像關鍵字一樣被轉成大寫。

自動完成會依照你的設定

當你接受一個 IntelliSense 建議後,SQLly 插入時會採用 Format SQL 對該語句的排版:關鍵字與函式的大小寫、識別碼的大小寫與引號方式、 JOIN 和 ON 放置位置,以及其他格式設定。例如,當 ON 子句位置 設定為 另起新行、 聯結建議 將其 ON 放在自己的行上。一個足夠短的語句對於 讓簡短查詢保持在同一行 會保持單行,就像 Format SQL 的輸出一樣。如果格式化工具無法讓結果與你輸入的內容對齊,建議就會原樣插入。

保持 SQL 不變

標記一塊區域,讓格式化工具保持距離、完全保留原樣:

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

此開關逐條陳述式生效。若陳述式是從 -- formatter:off 會保持原樣,之後的每個語句也一樣,直到遇到 -- formatter:on。放在陳述式中間的標記無法保護其中一部分,所以請在陳述式結尾加上 ; 或 GO 行。你可以用 遵循控制註解 在「註解」區段中。

不會傷害 SQL。 標記檢查讓格式化出錯時變成不做任何事,而不是產生損毀的 SQL。無法正確斷詞的 SQL(例如未結束的字串或註解)會原樣傳回,不會重新排版。註解永遠不會被丟棄。

在 Redis 連線上,格式化 SQL 不會有任何作用,因為它的編輯器裡是命令而不是 SQL。

精簡 SQL

反過來,也能壓成一行,方便放進日誌、JSON 負載或命令列, 精簡 SQL 會移除一般註解,並把所有空白壓縮成單一空格,但字串字面值、加引號的識別碼和以 $ 括住的內文都保持原樣,因此精簡後的 SQL 執行結果與原本完全相同。 -- sqlly 指令註解和 /*+ hint */ 最佳化提示,SQL Server 的 GO 分隔符會自成一列,因為伺服器有此要求;無法正確解析的 SQL 則維持原樣,不會被弄壞。

選取要壓縮的 SQL,或把游標放在某個陳述式中,或什麼都不選以壓縮整個查詢,然後按下 ⌘⌥⇧F (Ctrl+Alt+Shift+F 在 Windows 和 Linux 上)則會把它從查詢中移除。 查詢 › 壓縮 SQL,或以空格或引號開頭或結尾;引號裡面要表示引號本身,就把它寫兩次。