@kasthor/redis-pooling v1.1.1

Redis Pooling - A NodeJs module for creating redis connection pool

Redis Pooling - v1.0.11

This is a simple module for creating redis connection pool, it depends on NodeJS redis module and commands are almost the same besides it allows you to set maximum number of connections and distribute requests equally on each of them. Note: if maximum amount of connections is set to some number X then available connections will be no more then X, it can vary based on traffic

Getting started

Installation

you can use npm for installing this module

npm install redis-pooling

Configure

All you need is to require module and give it config object which should should have 'maxPoolSize' and 'credentials' properties. (note that client is singleton object)

var client = require('redis-pooling')({
        maxPoolSize: 10,
        credentials: {
            host: "127.0.0.1",
            port: "6379"
        }
    });

Usage Example

With callbacks

//setting value
client.set(key, value,function(err, data){
    if(err){
        //handle error
    }else{
        //do stuff with data
    }
});

//getting value
client.get(key, value,function(err, data){
    if(err){
        //handle error
    }else{
        //do stuff with data
    }
});

//incrementing
client.incr(key,function(err, data){
    if(err){
        //handle error
    }else{
        //do stuff with data
    }
});

With Promises

client.set(key, value).then(function(data){
    //success
}).catch(function(err){
    //handle error      
})

Currently available methods

set

get

incr

expire

expireat

auth

append

dbsize

del

dump

echo

exists

hdel

hexists

hget

hgetall

hincrby

hincrbyfloat

hkeys

hlen

hmget

hmset

hset

hsetnx

hstrlen

hvals

incrby

incrbyfloat

keys

lindex

lrange

lrem

lset

ltrim

randomkey

rename

renamenx

setnx

ttl

setex

sadd

smembers

sismember

config object

maxPoolSize

maxPoolSize - default 5

credentials