Nommer dans la base
Tables, colonnes, index, fonctions SQL, déclencheurs, migrations et droits.
Le nom d’une clé étrangère ou d’une fonction est une interface : un écran nomme une clé par sa contrainte et appelle une fonction par son nom. Renommer demande de changer le code qui l’appelle.
Les tables et les colonnes
Section intitulée « Les tables et les colonnes »NOM-BASE-01 · Nommez une table en snake_case, au singulier
Section intitulée « NOM-BASE-01 · Nommez une table en snake_case, au singulier »| À éviter | À faire |
|---|---|
affaires, LigneAffaire, tbl_affaire |
affaire, ligne_affaire |
aff, lig_aff |
affaire, ligne_affaire |
Usage constaté Le dépôt la suit presque partout ; aucun document ne la décide encore.
NOM-BASE-02 · Préfixez la table d’un module par le nom du module
Section intitulée « NOM-BASE-02 · Préfixez la table d’un module par le nom du module »| À éviter | À faire |
|---|---|
contrat_de_visite ajoutée au module des interventions |
intervention_contrat_de_visite |
meteo pour le plugin météo |
plugin_meteo_prevision |
Règle écrite Décidé dans les décisions sur les modules et les plugins.
Voir aussi. Les plugins
NOM-BASE-03 · Nommez les colonnes par leur sorte
Section intitulée « NOM-BASE-03 · Nommez les colonnes par leur sorte »| À éviter | À faire |
|---|---|
date_archive, archived, supprime |
archive_le |
createur, user |
cree_par |
montant |
montant_ht ou montant_ttc |
piece |
piece_id |
Usage constaté Le dépôt la suit presque partout ; aucun document ne la décide encore.
Exception. Une clé qui vise un code et non un identifiant prend le nom de l’objet : module, domaine.
NOM-BASE-04 · Nommez un index <table>_<colonnes>
Section intitulée « NOM-BASE-04 · Nommez un index <table>_<colonnes> »| À éviter | À faire |
|---|---|
absence_employe_idx |
absence_employe |
À décider Deux formes coexistent : sans suffixe, et avec _idx (28 index sur 180 environ).
NOM-BASE-05 · Nommez une contrainte par la règle qu’elle tient
Section intitulée « NOM-BASE-05 · Nommez une contrainte par la règle qu’elle tient »| À éviter | À faire |
|---|---|
chk1 |
planification_un_seul_objet |
devis_etat_check pour une règle subtile |
courriel_valide |
À décider Les deux formes coexistent.
Les fonctions et les déclencheurs
Section intitulée « Les fonctions et les déclencheurs »NOM-BASE-06 · Nommez une fonction SQL par un verbe à l’infinitif, et ses paramètres p_…
Section intitulée « NOM-BASE-06 · Nommez une fonction SQL par un verbe à l’infinitif, et ses paramètres p_… »| À éviter | À faire |
|---|---|
setRappel(type, fiche), rappel_set |
poser_un_rappel(p_type, p_fiche) |
get_rappels, rappels_list |
les_rappels(p_pour) |
Un paramètre d, n, t |
p_date, p_numero, p_texte |
| Pour… | Forme | Exemple |
|---|---|---|
| Poser, retirer, créer | poser_, retirer_, creer_ |
poser_un_rappel, creer_un_devis |
| Noter une trace | noter_ |
noter_une_erreur |
| Recalculer | calculer_ |
calculer_les_alertes |
| Lire une liste, une chose | les_, le_, la_, l_ |
les_rappels, la_fiche_operation |
| Lire ce qui est à la session | mes_, mon_ |
mes_societes |
| Composer un écran | page_ |
page_suivi |
| Un pas d’import | moulinette_ |
réservé à l’import |
Usage constaté Le dépôt la suit presque partout ; aucun document ne la décide encore.
Exception. Les verbes poser_, retirer_, creer_, noter_, calculer_ et les lectures les_, la_ sont des usages constatés. N’en créez pas de nouveau sans l’avoir demandé. garde() est la garde de droit ; il n’existe pas de famille garde_….
NOM-BASE-07 · Préfixez la fonction d’un module par le nom du module
Section intitulée « NOM-BASE-07 · Préfixez la fonction d’un module par le nom du module »| À éviter | À faire |
|---|---|
cartes_du_planning fournie par le module des interventions |
intervention_cartes_du_planning |
Règle écrite Décidé dans les décisions sur les modules et les plugins.
NOM-BASE-08 · Nommez un déclencheur par la règle qu’il tient
Section intitulée « NOM-BASE-08 · Nommez un déclencheur par la règle qu’il tient »| À éviter | À faire |
|---|---|
trigger_1, trg_affaire, maj_total |
devis_ligne_tient_le_total |
zz_ sans raison d’ordre |
Un nom sans préfixe |
Usage constaté Le dépôt la suit presque partout ; aucun document ne la décide encore.
Exception. Le préfixe trg_ existe sur 14 déclencheurs sur 109 : il n’est pas à reprendre.
NOM-BASE-09 · Nommez une migration AAAAMMJJHHMMSS_phrase_snake_case.sql
Section intitulée « NOM-BASE-09 · Nommez une migration AAAAMMJJHHMMSS_phrase_snake_case.sql »| À éviter | À faire |
|---|---|
20261017_fix.sql, migration_roles.sql |
20261017240000_une_societe_cree_ses_roles.sql |
Règle écrite Une migration jouée ne se réécrit pas ; le motif du nom est tenu partout dans le dépôt.
Les droits
Section intitulée « Les droits »NOM-BASE-10 · Écrivez un droit domaine.niveau, en minuscules
Section intitulée « NOM-BASE-10 · Écrivez un droit domaine.niveau, en minuscules »| À éviter | À faire |
|---|---|
peut_voir_affaires, AFFAIRES_VOIR, affaires.view |
affaires.voir |
maintenance.voir pour le module des interventions |
intervention.voir |
Usage constaté Le dépôt la suit presque partout ; aucun document ne la décide encore.
Règle écrite Le préfixe d’un module est décidé.
Exception. Un rôle s’écrit en minuscules, en un mot ou en snake_case, sans abréviation : gerant, charge_affaires. Ne confondez pas un droit et une clé de réglage (heures.compteur).
Référence rapide
Section intitulée « Référence rapide »| Règle | À retenir | Tenue par |
|---|---|---|
| NOM-BASE-01 | Nommez une table en snake_case, au singulier | Usage constaté |
| NOM-BASE-02 | Préfixez la table d’un module par le nom du module | Règle écrite |
| NOM-BASE-03 | Nommez les colonnes par leur sorte | Usage constaté |
| NOM-BASE-04 | Nommez un index <table>_<colonnes> |
À décider |
| NOM-BASE-05 | Nommez une contrainte par la règle qu’elle tient | À décider |
| NOM-BASE-06 | Nommez une fonction SQL par un verbe à l’infinitif, et ses paramètres p_… |
Usage constaté |
| NOM-BASE-07 | Préfixez la fonction d’un module par le nom du module | Règle écrite |
| NOM-BASE-08 | Nommez un déclencheur par la règle qu’il tient | Usage constaté |
| NOM-BASE-09 | Nommez une migration AAAAMMJJHHMMSS_phrase_snake_case.sql |
Règle écrite |
| NOM-BASE-10 | Écrivez un droit domaine.niveau, en minuscules |
Usage constaté, Règle écrite |