seneca-level-store

Seneca leveldb store

npm install seneca-level-store
20 downloads in the last month

seneca-level-store

Node.js seneca data storage module for LevelDB.

This module is a plugin for the Seneca framework. It provides a storage engine that uses LevelDB to persist data. This module is for production use. It also provides an example of a document-oriented storage plugin code-base.

Support

If you're using this module, feel free to contact me on twitter if you have any questions! :) @rjrodger

Current Version: 0.1.3

Tested on: Node 0.10.19, Seneca 0.5.13

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

Install

npm install seneca
npm install seneca-level-store

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

Queries

The standard Seneca query format is supported:

  • entity.list$({field1:value1, field2:value2, ...}) implies pseudo-query field1==value1 AND field2==value2, ...
  • you can only do AND queries. That's all folks. Ya'll can go home now. The Fat Lady has sung.
  • entity.list$({f1:v1,...},{sort$:{field1:1}}) means sort by field1, ascending
  • entity.list$({f1:v1,...},{sort$:{field1:-1}}) means sort by field1, descending
  • entity.list$({f1:v1,...},{limit$:10}) means only return 10 results
  • entity.list$({f1:v1,...},{skip$:5}) means skip the first 5
  • entity.list$({f1:v1,...},{fields$:['field1','field2']}) means only return the listed fields (avoids pulling lots of data out of the database)
  • you can use sort$, limit$, skip$ and fields$ together
  • entity.list$({f1:v1,...},{native$:[{-level-query-},{-level-options-}]}) allows you to specify a native level query, as per node-leveldb-native

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

Test

cd test
mocha level.test.js --seneca.log.print
npm loves you