MySQL database layer for Seneca framework

A Seneca.js data storage plugin


A storage engine that uses mySql to persist data. It may also be used as an example on how to implement a storage plugin for Seneca using an underlying relational store.

  • Version: 0.4.0
  • Tested on: Seneca 0.5.0
  • Node: 0.10, 0.11

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

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

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

npm install seneca
npm install seneca-mysql-store

To run tests, simply use npm:

npm run test
var seneca = require('seneca')()
seneca.use('mysql-store', {
seneca.ready(function () {
  var apple = seneca.make$('fruit')  = 'Pink Lady'
  apple.price = 0.99$(function (errapple) {
    console.log(" = " +

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$(function (errentity) { ... })
entity.load$({id: ...}, function (errentity) { ... })
entity.list$({property: ...}, function (errentity) { ... })
entity.remove$({id: ...}, function (errentity) { ... })

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.

With docker-machine and docker-compose installed run the following commands:

docker-compose build
docker-compose up

As with all seneca stores, you can access the native driver, in this case, the mysql connectionPool object using entity.native$(function (err, connectionPool) {...}).

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.

Copyright Mircea Alexandru 2015, Licensed under MIT.