seneca-geteventstore-store

A Seneca.js data storage plugin

This module is a plugin for Seneca.js. It provides a storage engine that uses GetEventStore to persist data and is ready for production use. It may also be used as an example on how to implement a storage plugin for Seneca.

For a gentle introduction to Seneca itself, see the senecajs.org site.

Install

To install, simply use npm. Remember you will need to install Seneca.js seperately.

npm install seneca
npm install seneca-geteventstore-store

Test

To run tests, simply use npm:

npm run test

Quick Example

var seneca = require('seneca')()
seneca.use('geteventstore-store',{
  host:'127.0.0.1',
  port: 2113
})

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  )
  })
})

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  )
  })
})

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) { ... })

Query Support

The standard Seneca query format is supported:

• .list$({f1:v1, f2:v2, ...}) implies pseudo-query f1==v1 AND f2==v2, ....

• .list$({f1:v1,...}, {sort$:{field1:1}}) means sort by f1, ascending.

• .list$({f1:v1,...}, {sort$:{field1:-1}}) means sort by f1, descending.

• .list$({f1:v1,...}, {limit$:10}) means only return 10 results.

• .list$({f1:v1,...}, {skip$:5}) means skip the first 5.

• .list$({f1:v1,...}, {fields$:['fd1','f2']}) means only return the listed fields.

Note: you can use sort$, limit$, skip$ and fields$ together.

Native Driver

As with all seneca stores, you can access the native driver, in this case, the geteventstore-clent client object using entity.native$(function (err, collection) {...}).

Contributing

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

License

Copyright Colm Harte 2015, Licensed under MIT.