@beweb/dao

Le Data Access Object pour les nuls !

Usage no npm install needed!

<script type="module">
  import bewebDao from 'https://cdn.skypack.dev/@beweb/dao';
</script>

README

favicon.png

PRÉSENTATION

Le Data Access Object (DAO) est un modèle de programmation qui permet à un serveur de traiter des requêtes d'accès aux données de différentes Bases De Données (DB).

Lorsque le serveur reçoit des requêtes, le DAO s'occupe de les traduire avant de les envoyer au bon format, peu importe la DB choisie.

INSTALLATION

  • Installation de la librairie via npm
$ npm install @beweb/dao
  • Import de la librairie
const DAO = require('@beweb/dao')
  • Instanciation d'une nouvelle DB dans une variable (chemin vers la DB)

SQLite

const db = new DAO.SQLite('/uri/of/database')

MySQL

const db = new DAO.MySQL('/uri/of/database')

MongoDB

const db = new DAO.MongoDB('/uri/of/database')

Redis

const db = new DAO.Redis('/uri/of/database')

UTILISATION

db : Instance du DAO lié à la Base De Données ciblée

'target' : Collection MongoDB / Table SQL / Clé Redis

element : Objet JavaScript a récupérer / insérer / mettre à jour

id : ID de l'Objet JavaScript à obtenir / supprimer

callback : Traitement à effectuer une fois les valeurs récupérées

  • create('target', element) ajoute un élement à la cible
let new_element = {}
db.create('example', new_element)
  • getAll('target', callback()) retourne toutes les données de la cible
db.getAll('example', elements => {
    console.log(elements)
})
  • getById('target', id, callback()) retourne la donnée correspondant à l'ID dans la cible
db.getById('example', element.id, element => {
    console.log(element)
})
  • update('target', element) modifie une donnée dans la cible
updated_element.key = new_value
db.update('example', updated_element)
  • delete('target', id) retire une donnée de la cible
db.delete('example', element.id)
  • seed('target', elements) remplie la cible avec une liste d'éléments

ATTENTION cette méthode réinitialise la cible, et ne doit être utilisée que pour des tests

db.seed('example', elements)
  • path représente le chemin de la DB fournie

ATTENTION modifier le path peut être dangereux pour l'intégrité des données

db.path = './databases/new.db'

Toutes les méthodes peuvent prendre une fonction de callback en dernier paramètre pour pouvoir gérer les réponses des requêtes, et les erreurs peuvent être gérées avec try et catch