Skip to content

Nommage des data stores

Explications

Les datastores sont des bases de données utilisables sur Make.

Dans le cas où vous devez les utiliser, vous aurez besoin de nommer :

  • la base de données
  • Le nom de la structure
  • le nom des champs

N.B. : pour ces conventions de nommage, nous utilisons les conventions issues de la méthodologie Predict_Table.

Convention de naming

Convention de nommage

DATA STORE NAME
STATE_Description_email_date

DATA STRUCTURE NAME
state_structure_name

ITEM STRUCTURE NAME
item_name

Détails


NAMINGDESCRIPTIONEXEMPLES
DATA STORE NAMENom de votre base de données.DEV_CRM-ACME_john@doe.com_2024-05-06

PROD_All-items_Shopify_Acmecom_john@doe.com_2024-09-12
STATE : En majuscule. Soit en DEV, soit en PROD.

Description : Démarrer avec une majuscule et ensuite en minuscule. Certains termes peuvent être en majuscule (ex. : CRM, TVA…). Si vous hésitez, faites ce qui est le plus lisible.

Email : en minuscule. L’email est la personne qui est en lead et responsable de la création et mise en place de cette base de données.

Date : format qui est en chiffre mais qui correspond à celui que vous avez le plus l’habitude d’utiliser.
DATA STRUCTURE NAMENom de votre table.dev_client
prod_client
dev_client_order
dev_shopify_order_webhook
State : permet de retrouver la bonne table sur le bon environnement lors de son utilisation (qui peut être dans un Data Store ou un JSON).

Nom de la table : toujours au singulier.
ITEM STRUCTURE NAMENom du type de champ.lastname
file_id
last_message_received
Nom du champ : toujours au singulier.

Exemples

Pour mieux comprendre, prenons un exemple de ce que nous pensons non conforme et donnons-en une version améliorée respectueuse de la méthodologie.

Non conforme à la méthodologie

Data Store Naming

Conforme à la méthodologie

NOM DONNÉ SUR LA STRUCTUREEXPLICATION DES ERREURSRÉÉCRITURE
My data store
  • Aucune information et donc aucune lisibilité
DEV_Email-flow-by-order_john@doe.fr_2024-09-21
email-compatibility-brevo
  • Pas de state
dev_email_brevo_compatibility
post_signatures_collaborators
  • Pas de state
  • Pluriel
dev_post_signature_collaborator
post_trainings_collaborators :
  • Pas de state
  • Pluriel
prod_post_training_collaborator
structure_webhooksendstatus_test
  • Pas de state
  • Pas de séparation des termes (manque de lisibilité)
  • Préférer le terme “sandbox” que “test” ou tout simplement utiliser “dev”.
sandbox_structure_webhook_send_status
dev_structure_webhook_send_status
Users
  • Pas de state
  • Pluriel
  • Majuscule
  • Manque un terme pour mieux comprendre la structure
dev_user
dev_user_info
webhook_brevo_infos_structure_test
  • Pas de state
  • Pluriel
  • Préférer le terme “sandbox” que “test” ou tout simplement utiliser “dev”.
sandbox_webhook_brevo_info_structure_sandbox
dev_webhook_brevo_info_structure