SQL-Formatter

funktional

Räum eine Abfrage auf, ohne ihre Bedeutung zu ändern. Der Formatter ist absichtlich vorsichtig.

Der Formatter ist konfigurierbar, aber er ist bewusst vorsichtig. SQLly re-lexiert und vergleicht seine Ausgabe Token für Token mit der Eingabe; jede Abweichung lässt Ihr SQL unangetastet. Es kann Einrückungen ändern, die Groß-/Kleinschreibung von Schlüsselwörtern anpassen und Klauseln ausrichten, ohne Risiken bei Kommentaren oder Literalen einzugehen.

SQL formatieren

Drücke ⌥⇧F (Alt+Shift+F unter Windows und Linux), wähle Bearbeiten › Dokument formatieren, oder Rechtsklick › Dokument formatieren um die ganze Abfrage zu formatieren, egal was ausgewählt ist. Um nur die Auswahl zu formatieren, drücke ⌘K ⌘F (Strg+K Strg+F) für Auswahl formatieren. Beide Tastenkürzel lassen sich ändern unter Einstellungen › Arbeitsbereich › Tastenkombinationen. Du kannst auch wählen Abfrage › SQL formatieren, benutze die Symbolleisten-Schaltfläche, oder führe es über die Befehlspalette aus: mit ausgewähltem Text wird nur die Auswahl formatiert. Sonst die ganze Abfrage. Hier ist eine einzeilige Abfrage mit den Standardeinstellungen:

-- 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

Schlüsselwörter und Funktionen werden großgeschrieben, jede Hauptklausel beginnt in einer neuen Zeile, Auswahllisten stehen gestapelt mit einer Spalte pro Zeile, die Tabellen nach FROM (mit ihren JOINs) und die Bedingungen nach WHERE und HAVING stehen auf eigenen eingerückten Zeilen, und AND/OR führen ihre Zeilen an. Eine einzelne Anweisung, die in 80 Zeichen passt, bleibt in einer Zeile: SELECT id, name FROM dbo.Users WHERE id = 1. Die Einrückung folgt den Tab-Einstellungen deines Editors, außer du entscheidest anders.

SQLly
Editor mit einer Multi-Join-Orders-Abfrage nach Format SQL, mit großgeschriebenen Schlüsselwörtern und Klauseln auf eigenen ZeilenEditor mit einer Multi-Join-Orders-Abfrage nach Format SQL, mit großgeschriebenen Schlüsselwörtern und Klauseln auf eigenen Zeilen
Eine einzeilige Multi-Join-Abfrage nach Format SQL: Schlüsselwörter in Großbuchstaben, eine Spalte pro Zeile und ausgerichtete Klauseln.

Formatieren während der Eingabe

das Formatieren während der Eingabe Umschalter oben in Einstellungen › Editor › Formatierung formatiert, während du tippst. Ist es eingeschaltet, wird durch Drücken Eingabe formatiert die Anweisung, die du gerade schreibst, neu, und der Cursor bleibt direkt hinter demselben Zeichen wie zuvor, sodass du dort weitertippst, wo du warst. Standardmäßig ist die Funktion aus; ohne sie formatierst du bei Bedarf mit Format Document (⌥⇧F auf macOS, Alt+Shift+F unter Windows und Linux, neu belegbar unter Einstellungen › Arbeitsbereich › Tastenkombinationen).

Drückst du die Eingabetaste, bleibt der Text unverändert, wenn:

  • Text ausgewählt ist, oder du mit mehreren Cursorn editierst;
  • der Tab auf einer Redis-Verbindung ist, deren Editor Befehle anstelle von SQL enthält;
  • die Anweisung nicht mit einem Anweisungs-Schlüsselwort beginnt: SELECT, INSERT, UPDATE, DELETE, WITH, CREATE, ALTER, DROP, MERGE, TRUNCATE, GRANT, REVOKE, BEGIN, DECLARE, oder EXEC.

Skripte und GO-Batches

Ein Skript mit mehreren Anweisungen wird Anweisung für Anweisung formatiert, jede beginnt in einer eigenen Zeile, und das Tastenkürzel für eine einzelne Zeile gilt nur, wenn der gesamte Text eine einzelne Anweisung ist. Anweisungen enden bei ; und für SQL Server bei einem GO Batch-Trennzeichen. GO bekommt immer eine eigene Zeile, in der Schreibweise deiner anderen Schlüsselwörter, zusammen mit jeder Wiederholungsanzahl (GO 5) oder Kommentar, der dieselbe Zeile belegt:

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

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

GO zählt nur dann als Trenner, wenn sie am Anfang einer Zeile steht, die sonst nichts enthält außer einer optionalen Zahl oder einem Kommentar, und wenn sie zwischen Anweisungen steht, wie sqlcmd von SSMS erwartet. Eine Spalte namens go in der Mitte einer Auswahlliste, [go], und go innerhalb eines Strings oder Kommentars wird als normales SQL behandelt. Mit dem Dialekt auf Auto-Erkennung markiert eine GO Zeile das Skript als SQL Server. Mit dem Dialekt auf eine andere Engine gesetzt, GO ist kein Trenner.

Einstellungen

Alles lebt in Einstellungen › Editor › Formatierung, die eine Live-Vorschau hat: Füg dein eigenes SQL ein und beobachte, wie es sich ändert, während du an den Einstellungen drehst. Der schnellste Einstieg ist ein Voreinstellung:

VoreinstellungStil
StandardDas oben gezeigte Layout.
KompaktKurze Klauseln und Auswahllisten bleiben in einer Zeile und AND/OR folgen ihren Zeilen.
ErweitertFührende Kommas, eine Leerzeile vor wichtigen Klauseln, ON in einer eigenen Zeile und ausgerichtete Operatoren, Datentypen und Aliase.
Großgeschriebene Schlüsselwörter / Klein geschriebene SchlüsselwörterDas Standardlayout mit Schlüsselwörtern und Funktionen in dieser Schreibweise.
Bestehende beibehaltenBehält deine Groß- und Kleinschreibung, Kommas und die Platzierung der Klauseln bei und bringt den Rest in Ordnung.

Die Wahl eines Presets überschreibt alle Layouteinstellungen, behält aber deine Formatierungs-Trigger bei (Formatieren während der Eingabe, Formatieren beim Speichern, und Formatieren beim Einfügen), sodass das Ausprobieren eines anderen Presets diese nicht mehr deaktiviert. Änderst du danach eine einzelne Einstellung, schaltet sie um auf Benutzerdefiniert. Einzelne Abschnitte decken ab: Groß-/Kleinschreibung von Schlüsselwörtern (insgesamt oder pro Gruppe wie Datentypen oder JOINs), Groß-/Kleinschreibung und Quoting von Bezeichnern, Klausel-Layout, Select-Listen, Komma-Stil, boolesche Bedingungen, CASE, Operatoren, JOINs, Funktionen, Unterabfragen und CTEs, DML, DDL, Kommentare, Einrückung, Zeilenlänge (standardmäßig 120) und Anweisungen. Die SQL-Dialekt Einstellung steht standardmäßig auf Auto Detect, was den Dialekt direkt aus dem SQL selbst ableitet.

Formatieren beim Speichern und Formatieren beim Einfügen liegen unter Formatierungsauslöser. Beide sind standardmäßig ausgeschaltet.

Platzierung von FROM und WHERE

Zwei Einstellungen unter Klausel-Layout bestimmen, ob der Körper einer Klausel in der Zeile des Schlüsselworts beginnt oder auf einer eigenen eingerückten Zeile darunter:

OptionWas es bewirkt
Tabelle nach FROMNeue Zeile, eingerückt (die Standardeinstellung) setzt die erste Tabelle auf eine eigene Zeile unter FROM, und richtet seine JOINs daran aus; ein ON auf eigener Zeile rückt einen Schritt weiter ein. Gleiche Zeile wie das Schlüsselwort lässt die Tabelle in der FROM Zeile, wobei JOINs, platziert über die JOIN-Layout Einstellung.
Erste Bedingung nach WHERE / HAVINGNeue Zeile, eingerückt (die Standardeinstellung) setzt die erste Bedingung in eine eigene Zeile unter WHERE oder HAVING, ausgerichtet an den AND/OR folgenden Zeilen. Gleiche Zeile wie das Schlüsselwort hält sie auf der Zeile des Schlüsselworts.

das Kompakt und Bestehende beibehalten Voreinstellungen halten beide auf der Zeile des Schlüsselworts. Ein Kommentar, der direkt nach FROM oder WHERE geschrieben wird, bleibt auf dieser Zeile.

CTEs, DML und Indexspalten

Diese Optionen steuern, wie gängige Anweisungsmuster angeordnet werden:

OptionWas es bewirkt
CTE-Stilgestapelten (die Standardeinstellung) setzt den Körper jedes CTEs in eigene Zeilen. Inline setzt jede CTE- name AS ( … ) in eine Zeile. Eine CTE, die ein -- Kommentar, oder der über die maximale Zeilenlänge hinausgehen würde, bleibt gestapelt.
DML-StilStandard (die Standardeinstellung) ist das übliche Layout. Kompakt setzt ein INSERT, UPDATE, DELETE, oder MERGE auf eine Zeile, wenn es die maximale Zeilenlänge erlaubt. Erweitert setzt jede INSERT Spalte, jedes VALUES Element und jede UPDATE SET Zuweisung auf ihre eigene Zeile und wird niemals durch Kurze Abfragen in einer Zeile belassen.
Mehrzeilige IndexspaltenWenn ein Index mehr als eine Spalte hat, geht jede Schlüsselspalte und jede INCLUDE Spalte eines CREATE INDEX auf ihre eigene Zeile. Dasselbe gilt für PRIMARY KEY, UNIQUE, INDEX, und KEY Spaltenlisten innerhalb CREATE TABLE. FOREIGN KEY Spaltenlisten bleiben, wie sie sind.
Nachgestellte Kommentare mit dem Ausdruck verschiebenFunktioniert zusammen mit Inline-Kommentare inline belassen. Sind beide an, ein Zeilenende- -- comment am Ende der Zeile seines Codes, nachdem der Formatter diese Zeile neu aufgeteilt hat.

das Kompakt und Erweitert Voreinstellungen aktivieren die passenden Optionen aus dieser Gruppe. In CREATE INDEX … ON table (…)behält der Tabellenname seine Groß- und Kleinschreibung; er wird nicht mehr wie ein Schlüsselwort großgeschrieben.

Vervollständigungen folgen deinen Einstellungen

Wenn du einen IntelliSense Vorschlag annimmst, fügt SQLly ihn so ein, wie Format SQL diese Anweisung darstellen würde: Groß-/Kleinschreibung von Schlüsselwörtern und Funktionen, Groß-/Kleinschreibung und Quoting der Bezeichner, JOIN und ON Platzierung und die restlichen Formatierungseinstellungen. Zum Beispiel mit Platzierung der ON-Klausel gesetzt auf In neuer Zeile, ein Join-Vorschlag setzt sein ON auf eine eigene Zeile. Eine Anweisung, die kurz genug für Kurze Abfragen in einer Zeile belassen bleibt in einer Zeile, genau wie bei Format SQL. Wenn der Formatter sein Ergebnis nicht mit dem abgleichen kann, was du getippt hast, wird der Vorschlag unverändert eingefügt.

SQL unangetastet lassen

Markiere einen Bereich, der exakt so bleiben soll, wenn der Formatter Abstand halten soll:

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

Der Schalter wirkt Anweisung für Anweisung. Eine Anweisung, die nach -- formatter:off beginnt, wird unverändert beibehalten, genauso wie jede Anweisung danach, bis ein -- formatter:on. Ein Marker mitten in der Anweisung schützt einen Teil davon nicht, also beende Anweisungen mit ; oder einem GO Zeile. Du kannst die Marker ausschalten mit Steuerkommentare beachten im Kommentarbereich.

Kann dem SQL nicht schaden. Die Token-Prüfung macht einen Formatierungsfehler zum No-op statt zu beschädigtem SQL. SQL, das sich nicht sauber lexen lässt, etwa mit einem nicht abgeschlossenen String oder Kommentar, wird unverändert zurückgegeben statt neu formatiert. Kommentare werden nie entfernt.

Format SQL hat bei Redis-Verbindungen keine Wirkung, deren Editor Befehle statt SQL enthält.

SQL minifizieren

Andersherum eine kompakte Zeile für ein Log, eine JSON-Payload oder eine Befehlszeile, SQL minifizieren entfernt normale Kommentare und reduziert alle Leerzeichen auf einzelne Leerzeichen, während Zeichenkettenliterale, Bezeichner in Anführungszeichen und Dollar-Quoting-Blöcke unberührt bleiben, sodass das kompakte SQL genau wie das Original ausgeführt wird. -- sqlly Direktivenkommentare und /*+ hint */ Optimierungshinweise werden beibehalten, ein SQL Server GO Trennzeichen behält seine eigene Zeile, weil der Server dies verlangt, und SQL, das sich nicht sauber parsen lässt, wird unverändert belassen, anstatt verfälscht zu werden.

Wähle das SQL aus, das komprimiert werden soll, oder setze den Cursor in eine Anweisung, oder wähle nichts aus, um die gesamte Abfrage zu minimieren, und drücke ⌘⌥⇧F (Strg+Alt+Shift+F unter Windows und Linux), wähle Abfrage › SQL minimieren, oder führe es über die Befehlspalette aus. Das Ergebnis landet als eine einzige rückgängig machende Änderung, sodass ein einziges Undo dein formatiertes SQL zurückbringt.