SQL formatieren: Regeln, nach denen der Formatierer sortiert

VeröffentlichtToolSQL-Formatierer

Inhalt
  1. Warum sind einzeilige Abfragen so schwer lesbar?
  2. Die Formatierungsregeln zum Selbermachen
  3. Wie Sie das formatierte Ergebnis lesen
  4. Häufige Missverständnisse
  5. Zusammenfassung
  6. Häufig gestellte Fragen

Ein SQL-Formatierer zieht eine lange, in einer Zeile zusammengeschriebene SQL-Abfrage klauselweise auseinander. In diesem Artikel erfahren Sie, nach welchen Regeln ein solcher Formatierer eine Abfrage ausrichtet. Das ist hilfreich, wenn Sie Zeit damit verbringen, einzeilige Abfragen aus Logs oder ORM-Ausgaben jedes Mal mühsam mit den Augen zu verfolgen.

Vorab das Wichtigste: Der Formatierer ändert nichts an der Bedeutung der Abfrage. Er passt nur Leerzeichen, Zeilenumbrüche und die Groß- und Kleinschreibung von Schlüsselwörtern an.

Zusammenfassung ① Großgeschrieben werden nur Wörter, die in einer vordefinierten Liste von SQL-Schlüsselwörtern stehen. Tabellen- und Spaltennamen sowie Zeichenketten in Anführungszeichen behalten ihre ursprüngliche Schreibweise. ② Jede wichtige Klausel wie SELECT, FROM, WHERE, JOIN, GROUP BY und ORDER BY beginnt in einer neuen Zeile. Bedingungen mit AND, OR und ON, Einträge nach einem Komma und Unterabfragen werden um eine Ebene eingerückt. ③ Geändert werden nur Leerzeichen, Zeilenumbrüche und die Schreibweise der Schlüsselwörter. Die Abfrage wird also unverändert gleich ausgeführt.

Warum sind einzeilige Abfragen so schwer lesbar?

Abfragen aus Anwendungs-Logs, von ORMs ausgegebene Abfragen oder in Slack eingefügte Abfragen stehen meist ohne Zeilenumbrüche in einer einzigen Zeile, etwa so: select a,b,c from t1 join t2 on ... where ... and ... order by ....

In dieser Form sieht man kaum, wo die SELECT-Liste endet und wo die Bedingungen beginnen. Wenn Sie zählen wollen, wie viele Bedingungen nach WHERE folgen, müssen Sie den Text von links bis zum Ende durchgehen.

Kommt eine Unterabfrage hinzu, ist zudem nicht mehr auf den ersten Blick zu erkennen, ob die Klammer ein weiteres SELECT enthält oder nur einen einfachen Funktionsaufruf. Diese Grenze im Kopf immer wieder neu zu ziehen, ist es, was ermüdet.

Die Formatierungsregeln zum Selbermachen

Ein Formatierer wendet immer wieder dieselben mechanischen Regeln an. Deshalb können Sie das Ergebnis auch ohne Werkzeug von Hand erreichen. Die Reihenfolge ist diese:

1. Nur Schlüsselwörter großschreiben. Großgeschrieben werden ausschließlich reservierte Wörter wie SELECT, FROM, WHERE, JOIN, AND, ON, GROUP BY und ORDER BY. Tabellennamen, Spaltennamen, Funktionsargumente und Zeichenketten in Anführungszeichen bleiben unverändert.

2. Bei jeder wichtigen Klausel eine neue Zeile beginnen. Jedes Mal, wenn SELECT, FROM, WHERE, HAVING, LIMIT, GROUP BY, ORDER BY oder eine JOIN-Variante (LEFT JOIN, INNER JOIN usw.) auftaucht, beginnt eine neue Zeile.

3. Bedingungen und Einträge um eine Ebene einrücken. Bedingungen, die mit AND, OR oder ON beginnen, sowie SELECT-Einträge nach einem Komma werden eine Stufe weiter eingerückt als die Klausel selbst.

4. Klammern von Unterabfragen weiter einrücken, Funktionsklammern direkt anfügen. Steht in der Klammer ein weiteres SELECT, wird der Inhalt eine Ebene tiefer eingerückt. Klammern von Funktionsaufrufen wie COUNT(*) bleiben dagegen direkt am Funktionsnamen.

Wenden Sie diese vier Regeln auf die folgende einzeilige Abfrage an:

select o.id, o.total, u.name from orders o join users u on u.id = o.user_id where o.total > 1000 and u.status = 'active' order by o.total desc;

Nach diesen Regeln sieht das Ergebnis so aus (bei einer Einrückung von 2 Leerzeichen):

SELECT o.id,
  o.total,
  u.name
FROM orders o
JOIN users u
  ON u.id = o.user_id
WHERE o.total > 1000
  AND u.status = 'active'
ORDER BY o.total DESC;

Dabei fallen ein paar Dinge auf: Die Zeichenkette 'active' wurde nicht großgeschrieben, und auch die Aliasse o und u sowie die Spaltennamen sind in ihrer kleingeschriebenen Originalform geblieben. Großgeschrieben wurden nur reservierte Wörter wie SELECT, FROM, JOIN, ON, WHERE, AND, ORDER BY und DESC.

Von Hand geht das zwar, aber sobald zehn Bedingungen aneinanderhängen oder Unterabfragen verschachtelt sind, wird schon das Zählen der Klammertiefe mühsam. Probieren Sie es mit unserem Werkzeug, dem SQL-Formatierer, aus.

SQL-Formatierer

Einfach einfügen: Schlüsselwörter werden großgeschrieben und jede Klausel erhält einen Zeilenumbruch. Ohne Installation und Registrierung direkt im Browser.

Wie Sie das formatierte Ergebnis lesen

Beim Blick auf das Ergebnis sollten Sie sich merken: Es hat sich nur die Form geändert. Dass die Abfrage nun auf mehrere Zeilen verteilt ist, bedeutet nicht, dass sie sich inhaltlich verändert hat.

Eine um eine Stufe eingerückte Zeile gehört zur Klausel direkt darüber. Ein eingerücktes AND unter WHERE ist eine zusätzliche Bedingung dieses WHERE, und ein SELECT, das nach einer öffnenden Klammer tiefer eingerückt ist, ist eine Unterabfrage.

Klammern von Unterabfragen erhöhen die Einrücktiefe um eine Stufe, Klammern von Funktionsaufrufen bleiben dagegen direkt am Namen. Allein anhand der Einrücktiefe erkennen Sie daher auf einen Blick, ob eine Klammer eine Unterabfrage oder nur eine einfache Funktion enthält.

Neben dem Ergebnis zeigt die Anzeige zwei Werte: die Anzahl der Ausgabezeilen und die Ausgabegröße (in Byte). Diese Zahlen geben lediglich die Länge des Textes nach der Formatierung an. Mit der Performance der Abfrage oder der Zahl der verarbeiteten Zeilen haben sie nichts zu tun.

Häufige Missverständnisse

Das verbreitetste Missverständnis lautet: „Nach dem Formatieren liefert die Abfrage ein anderes Ergebnis.“ Das Formatieren ändert nur Leerzeichen, Zeilenumbrüche und die Schreibweise der Schlüsselwörter. Die Bedeutung, die die Datenbank liest, bleibt dieselbe.

Eine Einschränkung sollten Sie ebenfalls kennen: SQL unterscheidet sich je nach Dialekt wie MySQL, PostgreSQL oder Oracle in Details der Syntax. Spezielle Syntax, die nicht in der Schlüsselwortliste des Formatierers steht, wird nicht als Klausel erkannt, sodass die Formatierung dort unpassend wirken kann. Das Werkzeug dient also als Orientierungshilfe für bessere Lesbarkeit.

Häufiges MissverständnisTatsächliches Verhalten
Nach dem Formatieren liefert die Abfrage ein anderes ErgebnisNur Leerzeichen, Zeilenumbrüche und die Schreibweise der Schlüsselwörter ändern sich, die Ausführung bleibt gleich
Jedes großgeschriebene Wort ist ein reserviertes WortNur Wörter aus der vordefinierten Schlüsselwortliste werden großgeschrieben
Auch Spalten- und Tabellennamen werden einheitlich großgeschriebenBezeichner und Zeichenketten in Anführungszeichen behalten ihre ursprüngliche Schreibweise
Jede Klammer erzeugt eine EinrückungNur Klammern von Unterabfragen werden eingerückt, Klammern von Funktionsaufrufen bleiben am Namen
Eine andere Einrückung verändert die Abfrage2 Leerzeichen, 4 Leerzeichen oder Tabulator unterscheiden sich nur im sichtbaren Abstand, die Bedeutung ist dieselbe

Zusammenfassung

  • Die Großschreibung gilt nur für die vordefinierte Schlüsselwortliste. Tabellen- und Spaltennamen sowie Zeichenketten in Anführungszeichen bleiben unverändert.
  • Jede wichtige Klausel wie SELECT, FROM, WHERE, JOIN, GROUP BY und ORDER BY beginnt in einer neuen Zeile. Bedingungen mit AND, OR und ON sowie Einträge nach einem Komma werden um eine Ebene eingerückt.
  • Klammern von Unterabfragen vergrößern die Einrückung, Klammern von Funktionsaufrufen bleiben am Namen. Allein an der Tiefe erkennen Sie daher den Unterschied.
  • Kommentare und Zeichenketten bleiben erhalten, und mehrere durch Semikolon getrennte Anweisungen werden jeweils einzeln formatiert.
  • Es ändert sich nur die Form, die Bedeutung bei der Ausführung bleibt gleich. Auch wenn Sie die Einrückung ändern (2 oder 4 Leerzeichen, Tabulator), bleibt die Bedeutung dieselbe.
SQL-Formatierer

Einfach einfügen: Schlüsselwörter werden großgeschrieben und jede Klausel erhält einen Zeilenumbruch. Ohne Installation und Registrierung direkt im Browser.

Häufig gestellte Fragen

Ändert sich das Ergebnis der Abfrage, wenn ich SQL formatiere?

Nein. Beim Formatieren werden nur Leerzeichen, Zeilenumbrüche und die Groß- und Kleinschreibung von Schlüsselwörtern angepasst. Die Bedeutung der Abfrage, die die Datenbank auslegt, bleibt unverändert. Bei dialektspezifischer Syntax kann die Formatierung allerdings unpassend ausfallen, betrachten Sie das Werkzeug daher als Orientierungshilfe für bessere Lesbarkeit.

Werden auch Spaltennamen oder Zeichenketten großgeschrieben?

Nein. Die Großschreibung gilt nur für Wörter aus der vordefinierten Schlüsselwortliste wie SELECT, FROM, WHERE und JOIN. Tabellen- und Spaltennamen, Funktionsargumente und Zeichenkettenliterale in Anführungszeichen behalten ihre ursprüngliche Schreibweise. Wenn Sie das Kontrollkästchen für die Großschreibung von Schlüsselwörtern deaktivieren, bleiben auch reservierte Wörter unverändert.

Kann ich mehrere Anweisungen auf einmal formatieren?

Ja. Mehrere durch ein Semikolon (;) getrennte Anweisungen werden jeweils einzeln formatiert. Jede Anweisung endet am Semikolon und erhält unabhängig davon ihre klauselweisen Zeilenumbrüche. Kommentare (-- , /* */) und der Inhalt von Zeichenketten bleiben bei der Formatierung unverändert.

Was ändert sich, wenn ich die Einrückung von 2 auf 4 Leerzeichen umstelle?

Es ändert sich nur die Breite des Abstands vor eingerückten Zeilen. Sie können zwischen 2 Leerzeichen, 4 Leerzeichen und Tabulator wählen. Egal, wofür Sie sich entscheiden: Die Stellen der Zeilenumbrüche und die Bedeutung der Abfrage bleiben gleich. Wenn Sie die Einstellung ändern, wird das Ergebnis sofort neu berechnet, ohne dass Sie eine Schaltfläche drücken müssen.

Dieser Artikel basiert auf unserem koreanischen Original. Koreanisches Original lesen

Ähnliche Artikel

  1. SQL-Parameter-Binding: Werte in Platzhalter einsetzenWie ?, :id und @name beim Parameter-Binding mit Werten belegt und escapt werden – Regeln für Zahlen, NULL, Strings, Kommentare und Fragezeichen im Text.
  2. Strings escapen: Was sich in JSON und JavaScript ändertTabelle zu Backslash, Anführungszeichen, Zeilenumbruch und Tab in JSON-/JS-Strings, dazu der Weg zurück per Unescape und typische Fehlerquellen.
  3. HTML-Tags entfernen: Nur den reinen Text behaltenSo entfernen Sie Tags und Zeichen wie & aus kopiertem HTML. Mit Regex-Anleitung und Beispielen zu den Optionen für Skripte/CSS, Zeilenumbrüche und Entities.
  4. Hochgestellt-Generator: x² und H₂O als Unicode kopierenSo wandeln Sie x² und H₂O in echte Unicode-Zeichen um und fügen sie in Messenger, Social Media und Dokumente ein. Mit Erklärung, warum manche Zeichen fehlen.
  5. SVG-Pfad-Koordinaten extrahieren: d-Attribut richtig lesenSo lesen Sie das d-Attribut eines SVG-Pfads: Befehle wie M, L, C und Z, Zahlenwerte und Export als JSON, Punktliste oder CSV – samt Stolperfallen.
  6. SVG in React-Komponente umwandeln: Was sich im JSX ändertWarum stroke-width und class in React Warnungen auslösen: Tabelle der camelCase-Regeln, Props-Spreading mit {...props} und Regeln für Komponentennamen.

Passende Tools