redis-poco v1.0.7

redis-poco

Stores objects in redis with filtering on attributes

Installation

npm install redis-poco

Usage

const RedisPoco = require('redis-poco')

const redisPoco = new RedisPoco({ 
    namespace: 'PocoTest', 
    port: 6379, 
    host: 'localhost',
    endpoint: 'redis://localhost:6379', 
    client: redis.createClient...,
    idAttribute: 'id',
    itemKey: 'Item',
    operatingSetsExpireSeconds: 60,
    attributes: ['A', 'B', 'C', 'D', 'E']
})

redisPhraseComplete.whenStore({id: 'id1', A: 26, B: ['x', 'y'], C: 'z', D: 26, E: true, F: 'z'})
            .then(() => redisPhraseComplete.whenStore({id: 'id2', A: 26, B: ['z', 'y'], C: 'z', D: 32, E: false, F: 'y'}))
            .then(() => redisPhraseComplete.whenFilter({A: {min: 26, max: 26}, B: ['x', 'y'], C: 'z', D: {max: 30}, E: true}))
            .then(() => redisPoco.whenRemove('id2'))
            .then(() => redisPoco.whenRemoveAll())
            .then(console.log)
            .then(redisPhraseComplete.whenQuit)                   

Api

new RedisPoco(options)

If options aren't passed, it uses defaults.

• namespace: The namespace used for the poco keys. The default is 'Poco'.
• port: Port address for the redis instance. The default is 6379.
• host: The hostname for the redis instance. The default is localhost.
• endpoint: Add the full endpoint for redis, an alternative to setting port and hostname.
• client: Use to pass in your own client.
• idAttribute: The id attribute of the object being stored. The default is 'id'.
• itemKey: The key under which the actual object json is store. The default is 'Item'.
• operatingSetsExpireSeconds: Temporary sets when filtering are expired after this interval. The default is 60.
• attributes: The attributes on which you are filtering. There are certain restrictions like they can only hold simple string, number or boolean or an array of strings.

whenRemoveAll()

Removes all objects under the namespace

whenStore(poco)

Adds the poco object and indexes it.

whenRemove(id)

Removes the poco object and it's indexes.

whenGet(id)

Gets the poco object from the store.

whenGetAttributeValues(attribute)

Use this to get the distinct bucket values for the attribute.

whenFilter(filter)

Returns all ids according to the filter. Note that numeric filters are specified as redis ranges. Ex: { min: 25, max: 32 }

whenQuit()

Call this to quit the redis connection when you are done unless you are passing in your own client.