Skip to content
Redis object relational mapper for NodeJs with a minimum of magic
CoffeeScript
Find file
Failed to load latest commit information.
conf
doc Move docs to doc Nov 15, 2012
lib Add create sample; Fix code in readme Jan 27, 2013
samples Add create sample; Fix code in readme Jan 27, 2013
src
test Check redid keys after each test Nov 16, 2012
.gitignore Config redid with appendonly Oct 3, 2012
.travis.yml Test agains 0.6, 0.7, 0.8 et 0.9 Nov 15, 2012
LICENSE
Makefile
README.md
index.js Implement coverage Nov 15, 2012
package.json

README.md

nodeBuild 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
Something went wrong with that request. Please try again.