# 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.

:::note[En bref]
- **NOM-BASE-01** · [Nommez une table en snake_case, au singulier](#nom-base-01--nommez-une-table-en-snake_case-au-singulier)
- **NOM-BASE-02** · [Préfixez la table d'un module par le nom du module](#nom-base-02--préfixez-la-table-dun-module-par-le-nom-du-module)
- **NOM-BASE-03** · [Nommez les colonnes par leur sorte](#nom-base-03--nommez-les-colonnes-par-leur-sorte)
- **NOM-BASE-04** · [Nommez un index `<table>_<colonnes>`](#nom-base-04--nommez-un-index-table_colonnes)
- **NOM-BASE-05** · [Nommez une contrainte par la règle qu'elle tient](#nom-base-05--nommez-une-contrainte-par-la-règle-quelle-tient)
- **NOM-BASE-06** · [Nommez une fonction SQL par un verbe à l'infinitif, et ses paramètres `p_…`](#nom-base-06--nommez-une-fonction-sql-par-un-verbe-à-linfinitif-et-ses-paramètres-p_)
- **NOM-BASE-07** · [Préfixez la fonction d'un module par le nom du module](#nom-base-07--préfixez-la-fonction-dun-module-par-le-nom-du-module)
- **NOM-BASE-08** · [Nommez un déclencheur par la règle qu'il tient](#nom-base-08--nommez-un-déclencheur-par-la-règle-quil-tient)
- **NOM-BASE-09** · [Nommez une migration `AAAAMMJJHHMMSS_phrase_snake_case.sql`](#nom-base-09--nommez-une-migration-aaaammjjhhmmss_phrase_snake_casesql)
- **NOM-BASE-10** · [Écrivez un droit `domaine.niveau`, en minuscules](#nom-base-10--écrivez-un-droit-domaineniveau-en-minuscules)
:::

## Les tables et les colonnes

### NOM-BASE-01 · Nommez une table en snake_case, au singulier

:::tip[Règle]
Sans accent ni majuscule, avec un nom d'objet complet.
:::

| À éviter | À faire |
| --- | --- |
| `affaires`, `LigneAffaire`, `tbl_affaire` | `affaire`, `ligne_affaire` |
| `aff`, `lig_aff` | `affaire`, `ligne_affaire` |

<span class="puce usage">Usage constaté</span> 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

:::tip[Règle]
Avant sa première production, une table d'un module porte le nom du module en préfixe. Une table de plugin porte `plugin_<nom>_`. Un plugin ne modifie jamais une table du cœur ou d'un 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` |

<span class="puce ecrite">Règle écrite</span> Décidé dans les décisions sur les modules et les plugins.

**Voir aussi.** [Les plugins](/modules/plugins/)

### NOM-BASE-03 · Nommez les colonnes par leur sorte

:::tip[Règle]
Une clé étrangère s'écrit `<objet>_id`. Un horodatage finit par `_le`, un auteur par `_par`, un montant porte sa base.
:::

| À éviter | À faire |
| --- | --- |
| `date_archive`, `archived`, `supprime` | `archive_le` |
| `createur`, `user` | `cree_par` |
| `montant` | `montant_ht` ou `montant_ttc` |
| `piece` | `piece_id` |

<span class="puce usage">Usage constaté</span> 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>`

:::tip[Règle]
Pour un nouvel index, écrivez sans suffixe `_idx`. Ne renommez jamais une clé primaire ou étrangère nommée par défaut (`<table>_pkey`, `<table>_<colonne>_fkey`) : l'API s'en sert.
:::

| À éviter | À faire |
| --- | --- |
| `absence_employe_idx` | `absence_employe` |

<span class="puce adecider">À décider</span> 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

:::tip[Règle]
Soit `<table>_<colonne>_check`, soit une phrase qui dit la règle. Préférez la phrase quand la règle n'est pas évidente.
:::

| À éviter | À faire |
| --- | --- |
| `chk1` | `planification_un_seul_objet` |
| `devis_etat_check` pour une règle subtile | `courriel_valide` |

<span class="puce adecider">À décider</span> Les deux formes coexistent.

## Les fonctions et les déclencheurs

### NOM-BASE-06 · Nommez une fonction SQL par un verbe à l'infinitif, et ses paramètres `p_…`

:::tip[Règle]
Une fonction qui agit commence par un verbe ; une fonction qui lit se nomme par ce qu'elle rend ; chaque paramètre d'entrée commence par `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 |

<span class="puce usage">Usage constaté</span> 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

:::tip[Règle]
Une fonction fournisseur d'un module porte le préfixe du module. Une fonction retirée de la base voit aussi son fichier retiré du dossier des fonctions.
:::

| À éviter | À faire |
| --- | --- |
| `cartes_du_planning` fournie par le module des interventions | `intervention_cartes_du_planning` |

<span class="puce ecrite">Règle écrite</span> 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

:::tip[Règle]
Une phrase en `snake_case`. Le préfixe `zz_` (ou `zzz_` pour passer encore après) n'a qu'une raison : le déclencheur doit passer après les autres de la même table, PostgreSQL les jouant dans l'ordre alphabétique.
:::

| À éviter | À faire |
| --- | --- |
| `trigger_1`, `trg_affaire`, `maj_total` | `devis_ligne_tient_le_total` |
| `zz_` sans raison d'ordre | Un nom sans préfixe |

<span class="puce usage">Usage constaté</span> 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`

:::tip[Règle]
La phrase est au présent, sans accent, commence par un article ou un verbe et dit ce que la migration change. L'horodatage est unique. Une migration jouée ne se réécrit jamais.
:::

| À éviter | À faire |
| --- | --- |
| `20261017_fix.sql`, `migration_roles.sql` | `20261017240000_une_societe_cree_ses_roles.sql` |

<span class="puce ecrite">Règle écrite</span> Une migration jouée ne se réécrit pas ; le motif du nom est tenu partout dans le dépôt.

## Les droits

### NOM-BASE-10 · Écrivez un droit `domaine.niveau`, en minuscules

:::tip[Règle]
Le domaine tient en un mot. Le niveau est `voir`, `ecrire`, `regler`, `gerer`, ou un verbe d'action explicite pour un droit particulier (`emettre`, `lancer`). Les droits d'un module prennent le nom du module en préfixe.
:::

| À éviter | À faire |
| --- | --- |
| `peut_voir_affaires`, `AFFAIRES_VOIR`, `affaires.view` | `affaires.voir` |
| `maintenance.voir` pour le module des interventions | `intervention.voir` |

<span class="puce usage">Usage constaté</span> Le dépôt la suit presque partout ; aucun document ne la décide encore.

<span class="puce ecrite">Règle écrite</span> 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

| 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 |

## Voir aussi

- [Nommer les choses](/regles/nommage/)
