A Seneca.js Data Storage Plugin

seneca-mysql-store

Description

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.

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.

Seneca compatibility

Supports Seneca versions 1.x - 3.x

Install

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

npm install seneca
npm install seneca-mysql-store

Quick Example

var seneca = require('seneca')()
seneca.use('mysql-store', {
  name:'senecatest',
  host:'localhost',
  user:'senecatest',
  password:'senecatest',
  port:3306
})
 
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. See the seneca-standard-query plugin for more details.

Extended Query Support

By using the seneca-store-query plugin its query capabilities can be extended. See the plugin page for more details.

Native Driver

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

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.

To run tests with Docker

Build the MySQL Docker image:

npm run build

Start the MySQL container:

npm run start

Stop the MySQL container:

npm run stop

While the container is running you can run the tests into another terminal:

npm run test

Testing for Mac users

Before the tests can be run you must run docker-machine env default and copy the docker host address (example: '192.168.99.100'). This address must be inserted into the test/dbconfig.example.js file as the value for the host variable. The tests can now be run.