Skip to content
Redis object relational mapper for NodeJs with a minimum of magic
CoffeeScript
Find file
Failed to load latest commit information.
conf Indentation as 2 spaces
doc
lib Add create sample; Fix code in readme
samples Add create sample; Fix code in readme
src
test
.gitignore Config redid with appendonly
.travis.yml Test agains 0.6, 0.7, 0.8 et 0.9
LICENSE Rename license and readme
Makefile Move docs to doc
README.md Add create sample; Fix code in readme
index.js Implement coverage
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.