Embellisseur SQL

De illisible à propre

Embellir SQL consiste à prendre une requête qui a été écrite pour une machine et à la réécrire pour une personne. Les bases de données acceptent volontiers une instruction entassée sur une seule ligne, mais les humains ont besoin de structure : un endroit où l'œil peut se reposer, une séparation claire entre les colonnes que vous sélectionnez et les tables que vous lisez, et une indentation qui reflète la profondeur d'imbrication d'une sous-requête. Une esthéticienne fournit tout cela automatiquement.

Le résultat n'est pas seulement plus joli, il est plus fiable. Lorsque chaque clause se trouve sur sa propre ligne, vous pouvez voir immédiatement si unJOINsonON, si un filtre a atterri accidentellement au mauvais endroit ou si deux colonnes ont été dupliquées. Le SQL désordonné cache les bugs ; SQL embelli les expose.

Ce qui est nettoyé

• L'espacement aléatoire et les tabulations parasites sont normalisés en une indentation cohérente.
• Chaque clause majeure —SELECT, FROM, WHERE, GROUP BY, ORDER BY— démarre une nouvelle ligne.
• Colonnes sélectionnées etWHEREse répartissent sur leurs propres lignes afin que les longues listes cessent de défiler latéralement.
• Les mots clés sont réécrits selon une convention unique tandis que vos identifiants conservent la casse que vous avez saisie.
• Les sous-requêtes entre parenthèses sont indentées d'un niveau plus profond que leur parent.

Chacun de ces changements est purement cosmétique, ce qui est exactement ce que vous attendez d'un embellisseur : une lisibilité maximale, aucun risque.

Un exemple rapide

Il s'agit du type de requête qu'une infrastructure d'application peut enregistrer :

select p.id,p.title,c.name from posts p join categories c on c.id=p.category_id where p.published=1 order by p.created_at desc

Après embellissement :

SELECT
  p.id,
  p.title,
  c.name
FROM
  posts p
  JOIN categories c
  ON c.id = p.category_id
WHERE
  p.published = 1
ORDER BY
  p.created_at DESC

La condition de jointure est désormais impossible à manquer, les colonnes se lisent comme une liste et la clé de tri est autonome. Même requête, expérience complètement différente.

Embellissez avant de vous engager

Une bonne habitude consiste à embellir une requête avant qu'elle ne soit intégrée dans un fichier de migration, une procédure stockée ou une pull request. Un formatage cohérent accélère la révision du code, car les réviseurs concentrent leur attention sur la logique et non sur le déchiffrement de la présentation. Cela permet également de conserver des différences de contrôle de version petites et significatives : lorsque tout le monde exécute le même embellisseur, une modification apportée à une colonne apparaît sous la forme d'une différence sur une ligne au lieu d'un remaniement de l'ensemble de l'instruction. Étant donné que cet outil s'exécute entièrement dans votre navigateur, vous pouvez nettoyer même les requêtes de production sensibles sans envoyer un seul caractère à un serveur.