Aller au contenu principal

Généralités

Règles

  • Génération des id :
    • utilisation de SEQUENCE dans Postgresql
    • Utilisation d'une séquence unique de façon générale et de séquences spécifiques pour les tables critiques.
    • En cas de besoin spécifique, on pourra utiliser des uuid générés coté java pour ces identifiants technique bdd
    • Cette séquence sera gérée en mode auto par hibernate
  • Génération de la bd : liquibase générera automatique la base au lancement en dev, pas de génération en prod.
  • Nommage des tables et colonnes :
    • Anglais pour être au plus proche du code qui est aussi en anglais sauf termes métier difficiles à traduire
    • Utilisation du format snake case (ex : ma_colonne)

Voir la FQR ainsi que cette FQR

Nommage clés étrangères

Les foreign key seront de la forme FK_colonne_table_courante__table_cible.
On sépare le nom de la table par un double underscore.
Les noms des tables et des colonnes sont en minuscules

Au besoin, on peut rajouter la colonne de la table cible (cas à la marge).

Ex :
Pour une table user avec un id et une table convention avec une colonne id_createur et id_validateur qui pointent sur un user (référençant son id) :

FK_id_createur__user

FK_id_validateur__user

Envoi des enums en sortie

On envoi le code des enums en sortie des API, l'attribut sera nommée de façon à le comprendre, ex: statusCode. Le label/libellé est donc géré côté front.
Il ne faudra pas oublier d'ajouter la doc à swagger en précisant que ce code fait partie d'une liste d'enum. Cela facilitera l'utilisation de ce code par d'autres applications.