redis-row-stream

stream items into a redis instance for storage

npm install redis-row-stream
2 downloads in the last week
4 downloads in the last month

Build Status

Send a stream of items to Redis

This module will take in objects or strings as a stream, and send it to Redis for storage, with a key of some specified prefix, followed by some index, such as "prefix:0".

Install

npm install redis-row-stream

Configuration

The RedisRowStream constructor should be passed an opts object as its argument, similar to the following:

var opts = { 
      keyPrefix: "simpleRowTest"
    , structure: "hash"
    , serverAddress: "localhost" 
    , serverPort: 6379 
    , redisOpts: {} 
  }

keyPrefix is the prefix to use for all keys. It will be followed by some index, as mentioned above, so in this case keys would be "simpleRowTest:0", "simpleRowTest:1", etc. If keyPrefix is left undefined, 'default' will be used

structure is the Redis data type to use. Valid options are 'string' or 'hash'. If structure is left undefined, 'string' will be used.

serverAddress is the address of Redis server (defaults to 'localhost'), and serverPort is the port on which the Redis server is listening (defaults to '6379').

The redisOpts field contains any options to pass to the Redis constructor, which are listed in the documentation for the node_redis module

Usage

For each incoming message, this module will persist the data to the specified Redis instance.

This example (based on one of the test cases) reads in a json file with an array of items, parses them, and sends each items to Redis.

var RedisRowStream = require('redis-row-stream')
  , fs = require('fs')
  , path = require('path')

var inFile = path.join('test', 'input', 'simpleData.json')
  , opts = { 
      keyPrefix: "simpleRowTest"
    , serverAddress: "localhost" 
    , serverPort: 6379 
    , redisOpts: {} 
  }

var redisStream = new RedisRowStream(opts)

fs.readFile(inFile, function (err, data) {
  if (err) throw err
  data = JSON.parse(data)
  for(var i=0; i<data.length; i++){
    redisStream.write(data[i]);
  }
})

Rather than sending items with .write(), a more typical example may simply pipe several streams together, for example: input.pipe(regexStream).pipe(redisStream). See the full example in the examples directory. The parse-strings example will create a file stream, use the regexStream instance to parse its items, and then pipe that output into Redis.

See the test cases for some usage examples.

Development

If you are going to do development, you may want to use the git pre-commit hook, which will check the redis-row-stream.js file using jshint script (if you have it installed) and run the mocha tests (mocha is in the node_modules directory). If either of these fail, the commit wont work. To use the hook, from project directory, run:

ln -s ../../pre-commit.sh .git/hooks/pre-commit

License

redis-row-stream is freely distributable under the terms of the MIT License.

Copyright (c) UT-Battelle, LLC (the "Original Author")

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, THE U.S. GOVERNMENT, OR UT-BATTELLE 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.

npm loves you