openhoat / anystore Goto Github PK

Anystore allow you to persist your datas into any store like a simple memory store, or Redis (soon MongoDB, mySQL).

It provides a generic store class that seamlessly wraps a database provider implementation.

The goal of this project is to provide a light and easy way to persist JSON datas with indexes and entities associations.

$ npm install anystore --save

Depending of the store you want to use, you will need some additional modules :

• Redis :

$ npm install redis hiredis --save

Look at the examples in optionalDependencies of package.json

Create an entity and get it back : example1

const Anystore = require('anystore');

const store = new Anystore.stores.MemoryStore(); // Default memory store provided for test purpose

store.start()
  .then(() => store.create('Contact', {username: 'doe', firstname: 'John', lastname: 'Doe'}))
  .then(data => {
    console.log('saved data :', data);
    return data.id;
  })
  .then(id => store.load('Contact', id))
  .then(data => {
    console.log('fetched data back again :', data);
  })
  .then(() => store.stop());

Anystore is a base class overriden by every store implementation. All available stores classes are exposed with "stores" static attribute.

In this example, the store is an instance of MemoryStore class.

Result :

$ node samples/example1
saved data : { firstname: 'John',
  lastname: 'Doe',
  id: '97ff185e-353c-48c8-b13d-f242ae996c84' }
fetched data back again : { firstname: 'John',
  lastname: 'Doe',
  id: '97ff185e-353c-48c8-b13d-f242ae996c84' }

The generated ID is a UUID v4.

Almost all provided methods are asynchronous, they accept a callback as last argument, and return a promise.

• new Anystore(opt) : create a datastore instance and, if opt is given, initialize it
• init(opt) : synchronously initialize the store
• start(opt, cb) : start the datastore (and initialize if needed)
• stop(cb) : stop the datastore

All features take a type (collection name) as first argument.

Basic features :

• CRUD : create / read / update / delete an entity
• List all entities of type
• Find any entity by index (schema required)
• Dump the store
• Reset the store

For more information, look at API doc

TODO

TODO

• Redis : full list of options as defined in redis.createClient()

Currently, following database systems are supported :

• Redis
• Memory : in-memory store for test purpose

TODO

For more complete examples look at mocha tests

Enjoy !