Skip to content

Latest commit

 

History

History
103 lines (71 loc) · 4.16 KB

README.md

File metadata and controls

103 lines (71 loc) · 4.16 KB
Raw

Redis client for Node.js

In a nutshell

  • Talk to Redis from Node.js
  • Fully asynchronous; your code is called back when an operation completes
  • Binary-safe; uses Node.js Buffer objects for request serialization and reply parsing
    • e.g. store a PNG in Redis if you'd like
  • Client API directly follows Redis' command specification
  • You have to understand how Redis works and the semantics of its command set to most effectively use this client
  • Supports Redis' new exciting PUBSUB commands
  • Automatically reconnects to Redis (doesn't drop commands sent while waiting to reconnect either) using exponential backoff

Synopsis

When working from a git clone:

var sys = require("sys");
var client = require("../lib/redis-client").createClient();
client.info(function (err, info) {
    if (err) throw new Error(err);
    sys.puts("Redis Version is: " + info.redis_version);
    client.close();
});

When working with a Kiwi-based installation:

// $ kiwi install redis-client

var sys = require("sys"), 
    kiwi = require("kiwi"),
    client = kiwi.require("redis-client").createClient();

client.info(function (err, info) {
    if (err) throw new Error(err);
    sys.puts("Redis Version is: " + info.redis_version);
    client.close();
});
  • Refer to the many tests in test/test.js for many usage examples.
  • Refer to the examples/ directory for focused examples.

Installation

This version requires at least Node.js v0.1.90 and Redis 1.3.8.

Tested with Node.js v0.1.93 and Redis 1.3.10.

You have a number of choices:

  • git clone this repo or download a tarball and simply copy lib/redis-client.js into your project
  • use git submodule
  • use the Kiwi package manager for Node.js

Please let me know if the package manager "seeds" and/or metadata have issues. Installation via Kiwi or NPM at this point isn't really possible since this repo depends on a unreleased version of Node.js.

Running the tests

A good way to learn about this client is to read the test code.

To run the tests, install and run redis on the localhost on port 6379 (defaults). Then run node test/test.js [-v|-q] where -v is for "verbose" and -q is for "quiet".

$ node test/test.js
..................................................................
...........................++++++++++++++++++++++++++++++++++++

[INFO] All tests have passed.

If you see something like "PSUBSCRIBE: unknown command" then it is time to upgrade your Redis installation.

Documentation

There is a method per Redis command. E.g. SETNX becomes client.setnx.

For example, the Redis command INCRBY is specified as INCRBY key integer. Also, the INCRBY spec says that the reply will be "... the new value of key after the increment or decrement."

This translates to the following client code which increments key 'foo' by 42. If the value at key 'foo' was 0 or non-existent, 'newValue' will take value 42 when the callback function is called.

client.incrby('foo', 42, function (err, newValue) {
    // ...
});

This can get a little wacky. I'm open to suggestions for improvement here.

Note: for PUBSUB, you should use subscribeTo and unsubscribeFrom instead of the generated methods for Redis' SUBSCRIBE and UNSUBSCRIBE commands. See this and this.

Notes

All commands/requests use the Redis multi-bulk request format which will be the only accepted request protocol come Redis 2.0.