readme.md

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

• Client::constructor
• Client::get
• Client::quit

Schema API

• Records::hash
• Records::identifier
• Records::index
• Records::property
• Records::name
• Records::serialize
• Records::temporal
• Records::unique
• Records::unserialize
• Records::validate

Records API

• Records::all
• Records::clear
• Records::count
• Records::create
• Records::exists
• Records::get
• Records::id
• Records::list
• Records::remove
• Records::update

Run tests

Start a redis server on the default port

redis-server ./conf/redis.conf

Run the tests with mocha:

make test