Redis ObjectDB

A promise based node module for saving searchable plain JavaScript objects to Redis. All API methods are executed as atomic Lua transactions to avoid data corruption.

Installation

npm install --save redis-objectdb

Status:

Example

const RedisObjectDB = require('redis-objectdb');

let store = new RedisObjectDB('mydb');

store.setSchema({
    cars: {
        definition: {
            color: 'string',
            mileage: 'int',
            convertible: 'boolean',
            purchaseDate: 'date'
        },
        indices: {
            first: {
                uniq: true,
                fields: [ 'purchaseDate', 'mileage' ]
            },
            second: {
                uniq: false,
                fields: [ 'color', 'mileage' ]
            }
        }
    }
}).then(function(schemaId) {
    return store.create('cars', {
        color: 'blue',
        mileage: 12345,
        convertible: true,
        purchaseDate: new Date('Sun Nov 01 2015 17:41:24 GMT+0000 (UTC)')
    })
}).then(function(id) {
    return store.find('cars', id);
}).then(function(object) {
    // object = {
    //     color: 'blue',
    //     mileage: 12345,
    //     convertible: true,
    //     purchaseDate: new Date('Sun Nov 01 2015 17:41:24 GMT+0000 (UTC)')
    // }
});

API

new RedisObjectDB(options, redisOptions)

setSchema(schemaDefinition)

getSchemaHash()

create(collection, attributes)

update(collection, id, attributes)

delete(collection, id)

get(collection, id)

exists(collection, id)

list(collection)

size(collection)

multi(transaction)

find(collection, searchAttributes)

findAll(collection, searchAttributes)

quit()

Supported data types

• Boolean
• Integer
• String
• Date
• Unix timestamp