Skip to content

agurha/node-ron

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

72 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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: '[email protected]'},
    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

About

Redis object relational mapper for NodeJs with a minimum of magic

Resources

License

Stars

Watchers

Forks

Packages

No packages published