/node-aerospike3

A NodeJS client for Aerospike 3 NoSQL DB.

Primary LanguageC++

node-aerospike3

A NodeJS client for Aerospike 3 NoSQL DB.

Build Status

Note: This is NOT the official nodejs-aerospike client. The official client is at https://github.com/aerospike/aerospike-client-nodejs.

Features

  • Connect to an aerospike cluster
  • Key operations
    • Put
    • Exists
    • Get
    • Remove
    • Operate
      • append_str
      • incr
      • prepend_str
      • read
      • touch
      • write_str
      • write_int64
      • write_int64

Install

TODO

Requirements

Binary

Binary compile

  • node-gyp module
  • g++

Run the tests

  • async nodejs module

2 clients

This package provides two aerospike clients. A low level one, wrapping the C client and another one adding queuing and being able to emit events.

Usage High Level client

Create a client and connect to the DB:

var aerospike = require('aerospike'),
    client = aerospike.createClient();

Connection options

The first argument of the connect method is:

  • Not provided, default to {host: "127.0.0.1", port: 3000}
  • an object with "host(=127.0.0.1)", "port(=3000)" as optional properties.
  • an array of objects defining a list of hosts

Put a key

client.keyPut({
  key: {ns: "test", set: "set", key: "__TEST_KEY_OK__"},
      record: {col1new: "value1-new", col2new: "value2-new", col3new: 3}
    },
    function(err) {
        assert.equal(err, undefined, "failed put-ok");
});

Get a key

all records (=columns)

client.keyGet({key: {ns: "test", set: "set", key: "__TEST_KEY_OK__"}},
    function(err, result) {
        assert.equal(err, undefined, "failed get-ok");
        assert.deepEqual(result, {col1new: "value1-new", col2new: "value2-new", col3new: 3});
});

specific records

client.keyGet({
  key: {ns: "test", set: "set", key: "__TEST_KEY_OK__"},
  record: ["col1new", "col3new"]
    },
    function(err, result) {
        assert.equal(err, undefined, "failed get-ok");
        assert.deepEqual(result, {col1new: "value1-new", col3new: 3});
});

Check if a key exists

client.keyExists({ns: "test", set: "set", key: "__TEST_KEY_OK__"},
    function(err, result) {
        assert.equal(err, undefined, "failed exists-ok");
        assert.equal(result, true);
});

Operate on a key

client.keyOperate({
  key: {ns: "test", set: "set", key: "__TEST_KEY_OK__"},
  ops: [
    {op: "append_str", col: "bin1", value: "_post"}, // Append to an existing column string
    {op: "incr", col: "bin1", value: 12}, // Increment the value of a column
    {op: "prepend_str", col: "bin1", value: "_post"}, // Prepend to an existing column string
    {op: "read", col: "bin1"}, // Read a value from a bin. This is ideal, if you performed an operation on a bin, and want to read the new value.
    {op: "touch"} // Touching a record will refresh its ttl and increment the generation of the record.
    {op: "write_str", col: "bin3", value: "write"} // write a string
    {op: "write_int64", col: "bin3", value: 123} // write an int64
  ]
  },
    function(err, result) {
        assert.equal(err, undefined, "failed operate-ok");
});

Usage Low Level client

Create a client and connect to the DB:

var aerospike = require('build/Release/aerospike_cpp'),
    client = aerospike.createClient();

client.connect({hosts: [{host: "127.0.0.1", port: 3000}]}, function(err) {
    if (err) throw err;
    if (client.isConnected() != true)
        throw "Should be true";
});

Connection options

The first argument of the Connect method is:

  • an object with a "host" key populated with an array of objects defining a list of hosts

Put a key

client.keyPut({
  key: {ns: "test", set: "set", key: "__TEST_KEY_OK__"},
      record: {col1new: "value1-new", col2new: "value2-new", col3new: 3}
    },
    function(err) {
        assert.equal(err, undefined, "failed put-ok");
});

Get a key

all records (=columns)

client.keyGet({key: {ns: "test", set: "set", key: "__TEST_KEY_OK__"}},
    function(err, result) {
        assert.equal(err, undefined, "failed get-ok");
        assert.deepEqual(result, {col1new: "value1-new", col2new: "value2-new", col3new: 3});
});

specific records

client.keyGet({
  key: {ns: "test", set: "set", key: "__TEST_KEY_OK__"},
  record: ["col1new", "col3new"]
    },
    function(err, result) {
        assert.equal(err, undefined, "failed get-ok");
        assert.deepEqual(result, {col1new: "value1-new", col3new: 3});
});

Check if a key exists

client.keyExists({ns: "test", set: "set", key: "__TEST_KEY_OK__"},
    function(err, result) {
        assert.equal(err, undefined, "failed exists-ok");
        assert.equal(result, true);
});

Operate on a key

client.keyOperate({
  key: {ns: "test", set: "set", key: "__TEST_KEY_OK__"},
  ops: [
    {op: "append_str", col: "bin1", value: "_post"}, // Append to an existing column string
    {op: "incr", col: "bin1", value: 12}, // Increment the value of a column
    {op: "prepend_str", col: "bin1", value: "_post"}, // Prepend to an existing column string
    {op: "read", col: "bin1"}, // Read a value from a bin. This is ideal, if you performed an operation on a bin, and want to read the new value.
    {op: "touch"} // Touching a record will refresh its ttl and increment the generation of the record.
    {op: "write_str", col: "bin3", value: "write"} // write a string
    {op: "write_int64", col: "bin3", value: 123} // write an int64
  ]
  },
    function(err, result) {
        assert.equal(err, undefined, "failed operate-ok");
});