Formateur SQL
fonctionnelNettoyez une requête sans en changer le sens. Le formateur est volontairement prudent.
Le formateur est configurable, mais il est délibérément prudent. SQLly re-lexe et compare sa sortie token par token avec l'entrée ; tout écart laisse votre SQL intact. Il peut réindenter, remettre les mots-clés en casse et aligner les clauses sans prendre de risques avec les commentaires ni les littéraux.
Formater le SQL
Appuyez sur ⌥⇧F (Alt+Shift+F sur Windows et Linux), choisissez Modifier › Mettre en forme le document, ou clic droit › Mettre en forme le document pour formater toute la requête quelle que soit la sélection. Pour formater uniquement la sélection, appuyez sur ⌘K ⌘F (Ctrl+K Ctrl+F) pour Mettre en forme la sélection. Les deux raccourcis peuvent être modifiés sous Paramètres › Espace de travail › Raccourcis clavier. Vous pouvez également choisir Requête › Formater SQL, utilisez le bouton de la barre d'outils, ou exécutez-le depuis la palette de commandes : avec du texte sélectionné, seule la sélection est formatée. Sinon, c'est toute la requête qui l'est. Voici une requête sur une seule ligne avec les paramètres par défaut :
-- 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
Les mots-clés et fonctions sont en majuscules, chaque clause principale commence une nouvelle ligne, les listes de sélection sont empilées une colonne par ligne, les tables après FROM (avec leurs
JOINs) et les conditions après WHERE et HAVING
sont sur leurs propres lignes indentées, et AND/OR ont chacun leur ligne. Une instruction seule qui tient en 80 caractères reste sur une seule ligne :
SELECT id, name FROM dbo.Users WHERE id = 1. L'indentation suit les réglages de tabulation de votre éditeur, sauf si vous choisissez autrement.


Formater au fur et à mesure
Le Formater au fur et à mesure commutateur en haut de Paramètres › Éditeur › Formatage formate pendant que vous tapez. Avec cette option activée, appuyer sur Entrée reformate l'instruction que vous êtes en train de taper, et le curseur reste juste après le même caractère qu'avant, vous continuez donc à taper là où vous étiez. C'est désactivé par défaut ; avec cette option désactivée, formatez à la demande avec Formater le document (⌥⇧F sur macOS, Alt+Shift+F sur Windows et Linux, reconfigurable sous Paramètres › Espace de travail › Raccourcis clavier).
Appuyer sur Entrée laisse le texte inchangé lorsque :
- le texte est sélectionné, ou vous éditez avec plusieurs curseurs ;
- l'onglet est sur une connexion Redis, dont l'éditeur contient des commandes plutôt que du SQL ;
- l'instruction ne commence pas par un mot-clé d'instruction :
SELECT,INSERT,UPDATE,DELETE,WITH,CREATE,ALTER,DROP,MERGE,TRUNCATE,GRANT,REVOKE,BEGIN,DECLARE, ouEXEC.
Scripts et lots GO
Un script avec plusieurs instructions est formaté une instruction à la fois, chacune commençant sur sa propre ligne, et le raccourci à une seule ligne ne s'applique que lorsque tout le texte est une seule instruction. Les instructions se terminent à ; et, pour SQL Server, à un
GO séparateur de lot. GO a toujours sa propre ligne, dans la même casse que vos autres mots-clés, avec le nombre de répétitions éventuel (GO 5) ou commentaire qui partage sa ligne :
-- before select 1 go select name from dbo.Users go -- after SELECT 1 GO SELECT name FROM dbo.Users GO
GO compte comme séparateur uniquement quand il commence une ligne qui ne contient rien d'autre qu'un comptage ou un commentaire facultatif, et qu'il se place entre des instructions, comme
sqlcmd et SSMS l'attendent. Une colonne nommée
go au milieu d'une liste de sélection, [go], et
go dans une chaîne ou un commentaire sont laissés comme du SQL ordinaire. Avec le dialecte sur Détection automatique, un GO ligne marque le script comme SQL Server. Avec le dialecte réglé sur un autre moteur, GO n'est pas un séparateur.
Paramètres
tout vit dans Paramètres › Éditeur › Formatage, qui a un aperçu en direct : collez votre propre SQL et regardez-le changer à mesure que vous ajustez les paramètres. Le démarrage le plus rapide est un préréglage:
| Préréglage | Style |
|---|---|
| Par défaut | La disposition illustrée ci-dessus. |
| Compact | Les clauses courtes et les listes de sélection restent sur une seule ligne, et AND/OR suivent leurs lignes. |
| Développé | Virgules en début de ligne, une ligne vide avant les clauses principales, ON sur sa propre ligne, et opérateurs, types de données et alias alignés. |
| Mots-clés en majuscules / Mots-clés en minuscules | La mise en page par défaut avec les mots-clés et fonctions dans cette casse. |
| Conserver l'existant | Conserve la casse, les virgules et le placement des clauses, et range le reste. |
Choisir un préréglage réécrit toutes les options de mise en forme, mais conserve vos déclencheurs de formatage (Formater au fur et à mesure, Formater lors de l'enregistrement, et Formater lors du collage), donc essayer un préréglage différent ne les désactive plus. Modifier ensuite un seul réglage le fait basculer vers Personnalisé. Les sections individuelles couvrent la casse des mots-clés (globale ou par groupe, comme les types de données ou les JOINs), la casse et les guillemets des identifiants, la disposition des clauses, les listes de sélection, le style des virgules, les conditions booléennes, CASE, les opérateurs, les JOINs, les fonctions, les sous-requêtes et les CTEs, le DML, le DDL, les commentaires, l'indentation, la longueur des lignes (120 par défaut) et les instructions. Le paramètre Dialecte SQL paramètre vaut Auto Detect par défaut, ce qui détermine le dialecte à partir du SQL lui-même.
Formater lors de l'enregistrement et Formater lors du collage sont sous Formater les déclencheurs. Les deux sont désactivés par défaut.
Placement de FROM et WHERE
Deux paramètres sous Disposition des clauses choisir si le corps d'une clause commence sur la ligne du mot-clé ou sur sa propre ligne en retrait en dessous :
| Option | Ce que cela fait |
|---|---|
| Table après FROM | Nouvelle ligne, indentée (par défaut) met la première table sur sa propre ligne sous FROM, et aligne ses JOINs avec elle ; un ON sur sa propre ligne s'indente d'un cran supplémentaire. Même ligne que le mot-clé garde la table sur la FROM ligne, avec JOINplacés par le Disposition des JOIN paramètre. |
| Première condition après WHERE / HAVING | Nouvelle ligne, indentée (par défaut) place la première condition sur sa propre ligne sous WHERE ou HAVING, alignée avec les lignes AND/OR lignes qui suivent. Même ligne que le mot-clé le maintient sur la ligne du mot-clé. |
Le Compact et Conserver l'existant Les préréglages gardent les deux sur la ligne du mot-clé. Un commentaire écrit juste après FROM ou WHERE reste sur cette ligne.
CTE, DML et colonnes d'index
Ces options contrôlent la disposition des formes d'instruction courantes :
| Option | Ce que cela fait |
|---|---|
| Style CTE | Empilé (par défaut) place le corps de chaque CTE sur ses propres lignes. En ligne place chaque name AS ( … ) de chaque CTE sur une seule ligne. Un CTE qui contient un -- comment, ou qui dépasserait la longueur maximale de ligne, reste empilé. |
| Style DML | Standard (par défaut) est la mise en page habituelle. Compact met un INSERT, UPDATE, DELETE, ou MERGE sur une ligne lorsqu'il tient dans la longueur maximale de ligne. Développé met chaque INSERT colonne, chaque VALUES élément, et chaque UPDATE SET affectation sur sa propre ligne, et n'est jamais réduite par Garder les requêtes courtes sur une seule ligne. |
| Colonnes d'index multi-lignes | Lorsqu'un index a plus d'une colonne, chaque colonne clé et chaque INCLUDE colonne d'un CREATE INDEX va sur sa propre ligne. Il en va de même pour PRIMARY KEY, UNIQUE, INDEX, et KEY listes de colonnes à l'intérieur CREATE TABLE. FOREIGN KEY Les listes de colonnes sont laissées telles quelles. |
| Déplacer les commentaires de fin avec l'expression | Fonctionne avec Les commentaires en ligne restent en ligne. Avec les deux activés, une fin de ligne -- comment reste à la fin de la ligne de son code après que le formateur a réorganisé cette ligne. |
Le Compact et Développé Les préréglages activent les options correspondantes de ce groupe. Dans CREATE INDEX … ON table (…), le nom de la table conserve sa casse ; il n'est plus mis en majuscules comme un mot-clé.
Les complétions suivent vos paramètres
Lorsque vous acceptez une suggestion IntelliSense
suggestion, SQLly l'insère avec la présentation que Format SQL donnerait à cette instruction : casse des mots-clés et des fonctions, casse et guillemets des identifiants, JOIN et
ON placement, et le reste de vos paramètres de formatage. Par exemple, avec
Placement de la clause ON défini sur Sur une nouvelle ligne, un
suggestion de jointure met son
ON sur sa propre ligne. Une instruction assez courte pour Garder les requêtes courtes sur une seule ligne demeure sur une seule ligne, tout comme elle le ferait avec Format SQL. Si le formateur ne peut pas aligner son résultat avec ce que vous avez tapé, la suggestion est insérée telle quelle.
Ne pas toucher au SQL
Marquez une zone à laisser exactement telle qu'elle est écrite quand le formateur doit s'effacer :
-- formatter:off SELECT weird , hand_aligned , columns -- left exactly as typed FROM t; -- formatter:on
L'interrupteur fonctionne une instruction à la fois. Une instruction qui commence après
-- formatter:off est conservée telle quelle, et il en est de même pour chaque instruction qui suit, jusqu'à un -- formatter:on. Un marqueur dans le milieu d'une instruction ne protège pas une partie de celle-ci, donc terminez les instructions avec ; ou un GO ligne. Vous pouvez désactiver les marqueurs avec Respecter les commentaires de contrôle dans la section Commentaires.
Format SQL ne fait rien sur les connexions Redis, dont l'éditeur contient des commandes plutôt que du SQL.
Minifier le SQL
Dans l'autre sens, une seule ligne compacte pour un journal, une charge utile JSON ou une ligne de commande,
Minifier le SQL supprime les commentaires ordinaires et réduit tous les espaces blancs à des espaces simples tout en laissant intacts les littéraux de chaîne, les identifiants entre guillemets et les blocs entre dollars, de sorte que le SQL compact s'exécute exactement comme l'original.
-- sqlly les commentaires de directive et /*+ hint */ les indicateurs d'optimiseur sont conservés, un séparateur SQL Server GO garde sa propre ligne parce que le serveur l'exige, et le SQL qui ne s'analyse pas correctement reste inchangé plutôt que d'être altéré.
Sélectionnez le SQL à compacter, ou placez le curseur dans une instruction, ou ne sélectionnez rien pour minifier toute la requête, et appuyez sur ⌘⌥⇧F (Ctrl+Alt+Maj+F sur Windows et Linux), choisissez Requête › Minifier le SQL, ou exécutez-le depuis la palette de commandes. Le résultat apparaît comme une seule modification annulable, donc une seule annulation restaure votre SQL formaté.