Style guide

Un petit guide qui indique plusieurs styles de référence pour la syntaxe SQL (création des tables, colonnes, etc.). [https://www.sqlstyle.guide/](Style guide)

Les points principaux :

  • Des identifiants et noms consistants
  • Une utilisation judicieuse des espaces, pour faciliter la lecture
  • Dates au format ISO 8601 YYYY-MM-DD HH:MM:SS.SSSSS et pas un truc complètement louche (au hasard: à base d'entiers ...)
  • Eviter les redondances
  • Inclure des commentaires là où c'est nécessaire, dans le style C (/* */ ou préfixé de -- ).

Conventions générales de nommages

  • Pas de mots réservés !
  • Longueur de 30 caractères maximum
  • Utilisation d'underscore là où on utiliserait intuitivement un espace
  • Si on utilise des abréviations, s'assurer qu'elles sont connues

Tables

  • Utiliser le mot collectif plutôt que le pluriel.
  • Ne pas utiliser de préfixes type tbl_ ou n'importe quelle notation hongroise (= on ne préfixe rien avec le type de la donnée)

Colonnes

  • Au singulier
  • Eviter id comme identifiant de la table
  • Eviter d'avoir une colonne qui porte le même nom que la table et vice-versa
  • Toujours utiliser des minuscules

Requêtes

  • On utilise les majuscules pour les mots réservés (SELECT, UPDATE, ...)
  • On évite les abréviations
  • Et on évite les fonctions spécifiques au moteur de db s'il existe une fonction qui exécute la même chose en ANSI SQL.

Il y a d'autres informations sur l'utilisation des espaces, des indentations, les sous-requêtes, etc.

A lire ;-)