jreeter / seneca-redis-store

Redis database driver for Seneca MVP toolkit

A Seneca.js data storage plugin

seneca-redis-store

A storage engine that uses redis to persist data.

seneca-redis-store's source can be read in an annotated fashion by,

• running npm run annotate
• viewing online.

The annotated source can be found locally at ./doc/redis-store.html.

If you're using this module, and need help, you can:

• Post a github issue,
• Tweet to @senecajs,
• Ask on the Gitter.

If you are new to Seneca in general, please take a look at senecajs.org. We have everything from tutorials to sample apps to help get you up and running quickly.

Install

To install, simply use npm. Remember you will need to install Seneca.js if you haven't already.

npm install seneca
npm install seneca-redis-store

You also need redis running locally. Please visit redis for more info about how to install and run redis

Test

To run tests, simply use npm:

npm run test

Quick Example

String Uri

var opts = {
  'redis-store': 'redis://user:pass@host:port'
}

String Uri with Redis Options

var opts = {
  'redis-store': {
    uri: 'redis://user:pass@host:port',
    options: {...}
  }
}

seneca.use('redis-store', opts);

seneca.ready(function() {
  var apple = seneca.make$('fruit')
  apple.name = 'Pink Lady'
  apple.price = 0.99
  apple.save$(function (err, apple) {
    console.log("apple.id = " + apple.id)
  })
})

See the full list of available Redis options.

Usage

You don't use this module directly. It provides an underlying data storage engine for the Seneca entity API:

var entity = seneca.make$('typename')
entity.someproperty = "something"
entity.anotherproperty = 100

entity.save$(function (err, entity) { ... })
entity.load$({id: ... }, function (err, entity) { ... })
entity.list$({property: ... }, function (err, entity) { ... })
entity.remove$({id: ... }, function (err, entity) { ... })

Contributing

The Senecajs org encourage open participation. If you feel you can help in any way, be it with documentation, examples, extra testing, or new features please get in touch.

License

Copyright Marius Ursache and other contributors 2016, Licensed under MIT.