Redis adapter for firenze.js ORM
JavaScript
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
src
.editorconfig
.eslintrc
.gitignore
.npmignore
.travis.yml
LICENSE
README.md
index.js
package.json

README.md

firenze-adapter-redis

Build Status Coverage Status npm Join the chat at https://gitter.im/fahad19/firenze

Redis database adapter for firenze.js

Install it with npm:

$ npm install --save firenze-adapter-redis

The adapter currently supports only setting/getting/deleting a particular key at this moment.

Contents

Usage

var f = require('firenze');
var Database = f.Database;
var RedisAdapter = require('firenze-adapter-redis');

var db = new Database({
  adapter: RedisAdapter,

  // optional config
  port: 6379,
  host: '127.0.0.1'
  options: {} // passed to `redis.createClient(port, host, options)`
});

Operations

Examples below assume you have an instance of a Post model already:

var Post = db.createModelClass({
  primaryKey: 'key',
  displayField: 'value'
});

Creating

var post = new Post({
  key: 'myUniqueKey',
  value: 'some value here...'
});

post.save().then(function (model) {
  var value = model.get('value'); // some value here...
});

Reading

var post = new Post({
  key: 'myUniqueKey'
});

post.fetch().then(function (model) {
  var value = model.get('value');
});

Updating

var post = new Post({
  key: 'myUniqueKey'
});

post.set('value', 'some new value...');

post.save().then(function (model) {
  var value = model.get('value');
});

Deleting

var post = new Post({
  key: 'myUniqueKey'
});

post.delete().then(function () {
  // delete successful
});

Testing

Tests are written with mocha, and can be run via npm:

$ npm test

License

MIT © Fahad Ibnay Heylaal