Redis object relational mapper for NodeJs with a minimum of magic
CoffeeScript Makefile
Latest commit aa8b705 Feb 15, 2017 @wdavidw wdavidw readme: update travis url

nodeBuild Status

Redis ORM for NodeJs


npm install ron


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

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

Run the tests with mocha:

npm run redis_start
npm test
npm run redis_stop

Note, the command above use a Docker container. You can use you're own Redis server by only running npm test after modifying the configuration file located in "conf/".

If Redis is installed, start a redis server on the default port: redis-server ./conf/redis.conf

If Docker is installed, start a container: docker run --name ron -p 6379:6379 -d redis redis-server --appendonly yes