Sb-collection-file NPM

collection-file

Description

Gère une collection de document json, persistant en fichier

API

Toutes les méthodes retournent une promise

new CollectionFile (file) : Création d'un objet collectionFile
CollectionFile.collection : Attribut en lecture seul permettant d'accéder à la collection
CollectionFile.create(structure, documents) : Permet de créer une collection vide ou initialisé avec une liste de documents
CollectionFile.getStructure() : Permet de récupérer la structure de la collection
CollectionFile.loadCollection : Permet de charger la collection depuis le disque et retourne la collection à jour
CollectionFile.insert(document) : Permet d'insérer un document, retourne le document avec son id
CollectionFile.update(document) : Permet de mettre à jour un document
CollectionFile.delete(id) : Permet de supprimer un document
CollectionFile.getById(id) : Permet de récupérer un document par son id
CollectionFile.find(query) : Permet de rechercher des documents en fonction d'une query
CollectionFile.getNbDocuments : Permet de récupérer le nombre de documents de la collection
CollectionFile.import(documents) : Import une liste de documents
CollectionFile.importToAppend(documents) : Import une liste de documents

Structure du json sauvegardé

{
  structure : {
    idName: "_id", /* default */
    jsonSchema: null, /* facultatif jsonSchema de validation d'un document */
    searchIndex: [properties1, properties2 ], /* facultatif, liste les champs text sur lequel la méthode search fera sa recherche */
  },
  documents: {
    id1: {...},
    id2: {...},
    ....
    id10: {...},
  }
}

Commande CLI

collection-file _commande_ [--collection|--coll|-c] _fichier_ [options]

--collection, --coll, -c: Fichiers de la collection. exemple -c /path/myCollection correspond au fichier /path/myCollection.structure.json et /path/myCollection.documents.json
commands:
- create|c : Création d'une collection
- insert|i : Insert un document dans la collection
- update|u : Mets à jour un document dans la collection
- delete|d : Suppression un document dans la collection
- get|g : Affiche un document
- find|f : Liste des documents en fonction d'une recherche
- import|m : Importe une liste de document
- help command : affiche l'aide d'une commande

L'aide

$ cli/collection-file.js help

Usage: cli/collection-file.js <commande> --collection fichier [options]

Commandes:
  create [options]  Création d'une collection                                      [aliases: cre, c]
  delete <id>       suppression d'un document                                      [aliases: del, d]
  find [options]    recherche de documents                                              [aliases: f]
  get <id>          Affichage d'un document                                             [aliases: g]
  insert [options]  insertion d'un document                                        [aliases: ins, i]
  update [options]  mise à jour d'un document                                      [aliases: upd, u]

Options:
  --collection, --coll, -c  chemin sur la collection                  [chaine de caractère] [requis]
  --help                    Affiche de l'aide                                              [booléen]

create

$ cli/collection-file.js help create

cli/collection-file.js create [options]

Options:
  --collection, --coll, -c       chemin sur la collection             [chaine de caractère] [requis]
  --help                         Affiche de l'aide                                         [booléen]
  --id-name, --id, -i            nom de l'attribut contenant l'identifant du document
                                                                               [chaine de caractère]
  --jsonschema, --jsc, -j        jsonschema de validation d'un document        [chaine de caractère]
  --jsonschema-file, --jscf, -f  fichier json contenant le jsonschema de validation d'un document
                                                                               [chaine de caractère]
  --documents-file, --doc, -d    fichier json contenant une liste de document à importer après la
                                 création                                      [chaine de caractère]

Divers pour le dev

TODO

CollectionFile.create ajouter la possibilité d'initialiser avec une liste de documents
(model) dans Collection.constructor valider le jsonschema (Ajv.validateSchema)
lors d'une creation si le fichier existe déjà refuser
cli : ajouter l'import
cli : internationaliser