node package manager

seneca-level-store

Seneca leveldb store

Seneca

A Seneca.js data storage plugin

seneca-level-store

npm version Build Status Coverage Status Code Climate Dependency Status Gitter

Lead Maintainer: Blain Smith

Description

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

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

  • running npm run annotate

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

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

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, 2.x and 3.x

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-level-store

Quick Example

var seneca = require('seneca')()
seneca.use('level-store', {
  folder: 'db'
})
 
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.

Testing with Docker

With docker installed run the following commands:

docker build -t level-store --no-cache .
docker run -i  level-store

Native Driver

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

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.

Test

To run tests, simply use npm:

npm run test

License

Copyright (c) 2010-2016, Richard Rodger and other contributors. Licensed under MIT.