@seneca/knex-store
v7.1.0
Published
Seneca data storag plugin for Knex.
Downloads
6
Readme
A Seneca.js data storage plugin.
seneca-knex-store
| | This open source module is sponsored and supported by Voxgig. | |---|---|
Description
seneca-knex-store is a [Knex] database/ORM plugin for the [Seneca][seneca] MVP toolkit.
The Seneca framework provides an ActiveRecord-style data storage API. Each supported database has a plugin, such as this one, that provides the underlying Seneca plugin actions required for data persistence.
This plugin is loaded by default by the seneca-entity plugin that also needs the seneca-basic plugin to function properly.
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.
Code examples
For code samples, please see the tests for this plugin.
Seneca compatibility
Supports Seneca versions 2.x and above
Supported functionality
All Seneca data store supported functionality is implemented in seneca-store-test as a test suite. The tests represent the store functionality specifications.
Install
npm install seneca
npm install seneca-knex-store
You'll need the seneca toolkit to use this module - it's just a plugin.
Quick Example
var seneca = require('seneca')()
seneca.use('basic')
.use('entity')
// Since knex-store is a default plugin, it does not need to be
// added with .use(). You can just go ahead and use it.
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) { ... })
Contributing
The Senecajs org encourages 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.
Test
To run tests, simply use npm:
npm run test
License
Copyright (c) 2015-2016, Richard Rodger and other contributors. Copyright (c) 2010-2014, Richard Rodger. Licensed under MIT.