node-ssdb

ssdb nodejs client library, ssdb is a fast nosql database, an alternative to redis.

Latest version: v0.0.8

Feel free to open an issue! =_-

Requirements

ssdb 1.6.8.8+

Installation

$ npm install ssdb

Example

The traditional Node.js way:

var ssdb = require('ssdb');
var client = ssdb.createClient();

client.set('key', 'val', function(err, data){
  if (!err) {
    console.log(data);
  } else throw err;
});

Work with TJ's co:

var co = require('co');
client.thunkify();

co(function *(){
  try{
    var key = 'key';
    var a = yield client.set(key, 'val');
    var b = yield client.get(key);
    console.log(a, b);  // 1 'val'
  } catch(e){
    throw e;
  }
})();

Work with promises:

client.promisify()

client.set('key', 'val')
.then(function(){
  return client.get('key')
}).then(function(d){
  console.log(d);  // 'val'
});

Callback Parameters

Callback functions have two parameters: error, data;

on status_ok: only error is undefined;
on status_not_found: error and data are both undefined
on status_client_error and other not_ok status: only data is undefined.

API References

createClient(options)

To make a ssdb client:

var ssdb = require('ssdb');
var client = ssdb.createClient();

options (with default values):

{
  host: '0.0.0.0',
  port: 8888,
  timeout: 0
}

client.quit()

Quit from ssdb server.

client.unref()

Equivalent to client.conn.sock.unref(), see http://nodejs.org/api/net.html#net_server_unref.

command names

ssdb.commands   // js object keys

Client events

'status_ok'

parameters: cmd, data

Listener example:

var util = require('util');

client.on('status_ok', function(cmd, data){
  console.log(util.format('%s replies ok, data: %s', cmd, data));
});

'status_not_found'

parameters: cmd

'status_client_error'

parameters: cmd

'status_not_ok'

parameters: status, cmd

Connection Events Handling

All events (except 'data) on nodejs's net.event.connect are avaliable (reference: http://nodejs.org/api/net.html)

event 'connect'
event 'end'
event 'timeout'
event 'drain'
event 'error'
event 'close'

client.on('error', function(err){
  log.error('ssdb connect error: %s', err);
});

SSDB API Documentation

Detail docs for ssdb interfaces can be found at: https://github.com/hit9/ssdb.api.docs

shenmao1989/node-ssdb