Redis object relational mapper for NodeJs with a minimum of magic
Clone or download
Pull request Compare This branch is 36 commits behind adaltas:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
conf
docs
lib
test
.gitignore
.travis.yml
Makefile
index.js
license.md
package.json
readme.md

readme.md

Build Status

Redis ORM for NodeJs

Installation

npm install ron

Usage

ron = require('ron');
// Client connection
client = ron({
    port: 6379
    host: '127.0.0.1'
    name: 'auth'
});
// Schema definition
Users = client.get('users');
Users.property('id', {identifier: true});
Users.property('username', {unique: true});
Users.property('email', {index: true, type: 'email'});
Users.property('name', {});
// Record manipulation
Users.create(
    {username: 'ron', email: 'ron@domain.com'},
    function(err, user){
        console.log(err, user.id);
    }
)

The library provide

  • Documented and tested API
  • Records access with indexes and unique values
  • Records are pure object, no state, no magic

Client API

Schema API

Records API

Run tests

Start a redis server on the default port

redis-server ./conf/redis.conf

Run the tests with mocha:

make test