paywell-redis

redis client factory and utilities

Requirements

• Redis 2.8.0+
• NodeJS 6.5.0+

Installation

$ npm install --save paywell-redis

Usage

//initialize redis with default options
const redis = require('paywell-redis')([options]);

//obtain normal redis client
const client = redis.client();

//obtain pub/sub clients
const { publisher, subscriber } = redis.pubsub();

//clear users data
redis.clear('users*', function(error, response){
    ...
});

//clear all data
redis.clear(function(error, response){
    ...
});

//reset and quit all clients
redis.quit();

Options

• prefix:String - redis key prefix. default to paywell
• separator:String - redis key separator. default to :
• redis:Object - redis connections options.

To initialize redis with custom options use

const redis = require('paywell-redis')({
    prefix:'q',
    separator:'-',
    redis: {
    port: 6379,
    host: '127.0.0.1'
  }
});

...

API

createClient([options:Object]):Object

Create a new instance of redis client

const redis = require('paywell-redis')();
const client = redis.createClient([options]);

...

pubsub():{publisher:Object, subscriber:Object}

Obtain existing or create new instances of publisher and subscriber redis clients

const redis = require('paywell-redis')();
const { publisher, subscriber } = redis.pubsub();

...

client():Object

Obtain existing or create new instance of redis client

const redis = require('paywell-redis')();
const client = redis.client();

...

multi():Object

Create new instance of redis multi command object

const redis = require('paywell-redis')();
const client = redis.multi();

...

info(done:Function):Object

Obtain informations of the current redis server.

const redis = require('paywell-redis')();
redis.info(function(error, info){
    ...
});

key(...args):String

Build redis storage key using prefix and separator options

const redis = require('paywell-redis')();

//generate random key
const key = redis.key();
expect(key).to.exist;
expect(key.split(':')).to.have.length(2);

const key = redis.key('ab');
expect(key).to.be.equal('paywell:ab');

const key = redis.key(['users', 'ab']);
expect(key).to.be.equal('paywell:users:ab');

const key = redis.key('users', 'likes', 'vegetables');
expect(key).to.be.equal('paywell:users:likes:vegetables');

...

clear(pattern:String,[done:Function]):Array[String>

clear data using specified pattern. if pattern not provided all data will be deleted

const redis = require('paywell-redis')();

//clear all data
redis.clear(function(error, responses){
    ...
});

//clear all key 'users*'
redis.clear('users',function(error, responses){
    ...
});

...

reset()

Reset current state of redis

const redis = require('paywell-redis')();
redis.reset();

...

HASH

Store object into redis hash datatype. Before saving the whole of object is flatten'ed and serialized. i.e all dates will be converted to timestamps etc.

save(object:Object,[options:Object],done:Fuction)

Save given object as a flat redis hash.

Options:

• index:Boolean - whether to index the object or not for search. default to true.
• collection:String - name of collection or namespace used in prefix hash keys. default to hash
• ignore: Array[String] - Collection of object fields to ignore when indexing

const object = ...;
redis.hash.save(object, function (error, _object) {
    ...
});

const user = ...;
redis.hash.save(user, {collection:'users'}, function (error, _object) {
    ...
});

get(...keys,done:Function)

Get single or multiple saved object using their keys

//get single
redis.hash.get(<id>, function(error, object){
   ...
});

//get multiple object
redis.hash.get([<id>, <id>], function(error, objects){
   ...
});

//get multiple object
redis.hash.get(<id>, <id>, function(error, objects){
   ...
});

search(options:String|Object,done:Function)

Search existing objects.

Options:

• type:String - type of reds search. default to or
• collection:String - name of collection used in searching. default to hash
• q: String - query string. default to ''

//search default collection
redis.hash.search(<search_query>, function (error, objects) {
    ...
});

//search specific collection
redis.hash.search({
    q: objectx.username,
    collection: 'users',
    type:'or'
  }, function (error, objects) {
    ...
});

References

• store-javascript-objects-in-redis-with-node-js-the-right-way
• reds-internals-searching-and-better-searching-with-node-js-and-redis

Testing

• Clone this repository

• Install all development dependencies

$ npm install

• Then run test

$ npm test

Contribute

It will be nice, if you open an issue first so that we can know what is going on, then, fork this repo and push in your ideas. Do not forget to add a bit of test(s) of what value you adding.

Licence

The MIT License (MIT)

Copyright (c) 2016 byteskode, paywell, lykmapipo & Contributors

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.