Update
Entités autres que Project
La méthode save rattache une entité enfant à son entité parente et enregistre son état en mémoire. Elle renvoie l'entité parente mise à jour avec la nouvelle version de l'entité enfant.
Signature : <S,T>(parentEntity: S, entity: T) => S
// Crée une entité Project
let project = await Entities('Project').create();
// Crée une entité Company
const company = await Entities('Company').create();
// Rattache l'entité Company à l'entité Project
project = await Entities('Company').save(project, company);Path
La fonction Entities accepte en paramètre un path pour sauvegarder facilement une ou plusieurs entités imbriquées.
Le path est divisé en segments dont chacun représente une entité.
Le path doit respecter les règles :
- Les segments sont séparés par le caractère ..
- La résolution d'un segment doit correspondre à exactement une entité. La seule exception est le dernier segment.
- Le critère pour sélectionner une entité parmi plusieurs est spécifié entre crochets, et doit respecter la syntaxe: [PROPERTY_NAME=VALUE], où PROPERTY_NAME est le nom d'une des propriétés de l'entité.
La signature de la fonction save est alors : <S>(parentEntity: S, entity: object[]) => S.
Chaque entité à sauvegarder est successivement associée à un segment du path. Cette correspondance est réalisée en partant du dernier segment. Le nombre des entités à sauvegarder doit donc être inférieur ou égal au nombre de segments du path.
Exemples :
- Sauvegarde d'une entité e1 sur le path A.B.C : l'entité e1 correspond au segment C.
- Sauvegarde des entités e1 et e2 sur le path A.B.C : l'entité e2 correspond au segment C, et l'entité e1 correspond au segment B.
// Exemple
// A partir de l'entité `project`
// sauvegarde d'une entité `Aml`
// qui est rattaché à une entité `Contact`
// dont la propriété `companyName` est `company1`
await Entities('Contact[companyName=company1].Aml').save(project, [aml]);Le path donné à la fonction Entities doit être relatif à l'entité passée à la fonction save.
Entité Project
La méthode save enregistre en base de données l'arbre des entités. Elle renvoie la nouvelle version de l'entité Project, avec le statut et l'historique mis à jour.
La valeur null est retournée si l'entité Project n'existe pas en base de données.
Signature : <T>(projectEntity: T) => Promise<T | null>
// Crée une entité Project
let project = await Entities('Project').create();
// Crée une entité Company
const company = await Entities('Company').create();
// Rattache l'entité Company à l'entité Project
project = await Entities('Company').save(project, company);
// Sauvegarde en base de données les entités Project et Company
project = await Entities('Project').save(project);La persistance en base de données n'est réalisée qu'à l'appel de la fonction save sur l'entité Project. Avant l'appel à cette fonction de sauvegarde toutes les données sont traitées en mémoire.