level-orm

Simple ORM built on leveldb/levelup.

Installation

This module is installed via npm:

$ npm install level-orm

Usage

Basic usage examples

You extend the base class to give you ORM getters and setters.

NB: You pass in a 'container' object to the Model constructor which must have a leveldb instance on the db property of the object. This allows you to share state between models by passing in the same container object for each sublevel model object that you create.

var level = require('level');
var db = level('/tmp/db', { valueEncoding: 'json' });
var Model = require('level-orm');
function Users(db) {
  // users is the sublevel name to user
  // handle is the primary key to user for insertion
  Models.call(this, { db: db }, 'users', 'handle');
}
util.inherits(Users, Models);

var users = new Users(db);

// save to database
users.save({ handle: 'eugeneware', name: 'Eugene', email: 'eugene@noblesamurai.com' },
  function (err, id) {
    // id will be the primary key
  });

// retrieve from database
users.get('eugeneware', function (err, user) { });

// delete from database
users.del('eugeneware');

// stream from database
users.createReadStream({start: 'a', end: 'c'}).pipe(...);

Compound Keys

If you use bytewise you can have compound keys, like so:

var level = require('level');
var bytewise = require('bytewise/hex');
var db = level('/tmp/db', { keyEncoding: bytewise, valueEncoding: 'json' });
var Model = require('level-orm');

function Feed(db) {
  // compound key of 'user' and 'id'
  Models.call(this, { db: db }, 'feed', ['user', 'id']);
}
util.inherits(Feed, Models);

var feed = new Feed(db);
feed.save({ user: 'eugeneware', id: 123, message: 'Test' }, cb);

NB: That in leveldb the default encoding is 'utf8' where keys will sort lexicographically. Thus 10 will sort before 2 unless you use an encoding such as bytewise to change this behaviour.

Auto Incremented Keys

Implement the keyfn function on the extended model to automatically generate keys when none is found in the model to be saved:

var level = require('level');
var bytewise = require('bytewise/hex');
// we're just going to use a unique timestamp for our keys
var timestamp = require('monotonic-timestamp');
var db = level('/tmp/db', { keyEncoding: bytewise, valueEncoding: 'json' });
function Messages(db) {
  Models.call(this, { db: db }, 'messages', 'id');
}
util.inherits(Messages, Models);
// set the function to generate ids
Messages.prototype.keyfn = timestamp;

var messages = new Messages(db);
messages.save({ message: 'My message' }, function (err, id) {
  // id will contain the auto-generated ID
});

Shared container with multiple sublevel models

var level = require('level');
var bytewise = require('bytewise/hex');
var timestamp = require('monotonic-timestamp');

// Container class
function LevelMicroBlog(dbPath) {
  this.db = sublevel(level(dbPath, { keyEncoding: bytewise, valueEncoding: 'json' }));
  this.Users = new Users(this);
  this.Messages = new Messages(this);
}

LevelMicroBlog.prototype.close = function(cb) {
  if (this.db) return this.db.close(cb);
  this.db = null;
  cb(null);
}

// Users sublevel model
function Users(container) {
  Models.call(this, container, 'users', 'handle');
}
util.inherits(Users, Models);

// Messages sublevel model
function Messages(container) {
  Models.call(this, container, 'messages', 'id');
}
util.inherits(Messages, Models);
Messages.prototype.keyfn = timestamp;

// instantiate a new container class
var mblog = new LevelMicroBlog('/tmp/db');
mblog.Users.save({ 'handle': 'EugeneWare', name: 'Eugene Ware'}, ...);
mblog.Messages.save({ message: 'A new message' }, ...);

Use binary bytewise encoded sublevels

The original level-sublevel(https://github.com/dominictarr/level-sublevel) didn't support binary encodings, but as of 0.6 of sublevel, you can use native bytewise encoding of sublevels. If you want this, then require level-orm/bytewise and the underlying sublevel will use bytewise to encode sublevels:

var Model = require('level-orm/bytewise');
// extend as usual

License

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
Neither the name of Deoxxa Development nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY EUGENE WARE ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL DEOXXA DEVELOPMENT BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

eugeneware / level-orm

readme