izagz/node-tarantool-driver

Node tarantool driver for 1.6

node-tarantool-driver

Node tarantool driver for 1.6 support Node.js v.0.12+ and IO.js.

Based on https://github.com/mialinx/go-tarantool-1.6 and implements http://tarantool.org/doc/dev_guide/box-protocol.html, for more information you can read them or basic documentation at http://tarantool.org/doc/.

For work with tarantool tuple i use msgpack-lite and array default transformation with this package.

If you have a problem with connection it will be destroyed. You can subscribe on TarantoolConnection.socket.on('close') for retrieve information about closing connection or you can process rejected errors for you requests.

##Install

npm install --save tarantool-driver

##Usage example

We use TarantoolConnection instance and connect before other operations. Methods call return promise(https://developer.mozilla.org/ru/docs/Web/JavaScript/Reference/Global_Objects/Promise). Available methods with some testing: select, update, replace, insert, delete, auth, destroy.

var TarantoolConnection = require('tarantool-driver');
var conn = new TarantoolConnection({port: 3301});
conn.connect()
.then(function(){
  //auth for login, password
  return conn.auth('test', 'test');
}).then(function(){
  // select arguments space_id, index_id, limit, offset, iterator, key
  return conn.select(512, 0, 1, 0, 'eq', [50]);
})
.then(funtion(results){
  doSomeThingWithResults(results);
});

##Msgpack implentation

You can use any implementation that can be duck typing with next interface:

//msgpack implementation example
/*
    @interface
    decode: (Buffer buf)
    encode: (Object obj)
 */
var exampleCustomMsgpack = {
    encode: function(obj){
        return yourmsgpack.encode(obj);
    },
    decode: function(buf){
        return yourmsgpack.decode(obj);
    }
};

By default use msgpack-lite package.

##API

class TarantoolConnection(options)

var defaultOptions = {
    host: 'localhost',
    port: '3301',
    log: false,
	  msgpack: require('msgpack-lite'),
    timeout: 3000
};

You can overrid default options with options.

connect() : Promise

Resolve if connected. Or reject if not.

auth(login: String, password: String) : Promise

Auth with using chap-sha1(http://tarantool.org/doc/book/box/box_space.html). About authenthication more here: http://tarantool.org/doc/book/box/authentication.html

select(spaceId: Number or String, indexId: Number or String, limit: Number, offset: Number, iterator: Iterator, key: tuple) : Promise( Array of tuples)

Iterators: http://tarantool.org/doc/book/box/box_index.html. Available iterators: 'eq', 'req', 'all', 'lt', 'le', 'ge', 'gt', 'bitsAllSet', 'bitsAnySet', 'bitsAllNotSet'.

It's just select. Promise resolve array of tuples.

Some examples:

conn.select(512, 0, 1, 0, 'eq', [50]);
//same as
conn.select('test', 'primary', 1, 0, 'eq', [50]);

You can use space name or index name instead if id but it will some requests for get this metadata. That information actual for delete, replace, insert, update too.

delete(spaceId: Number or String, indexId: Number or String, key: tuple) : Promise(Array of tuples)

Promise resolve an array of deleted tuples.

update(spaceId: Number or String, indexId: Number or String, key: tuple, ops) : Promise(Array of tuples)

Ops: http://tarantool.org/doc/book/box/box_space.html (search for update here).

Promise resolve an array of updated tuples.

insert(spaceId: Number or String, tuple: tuple) : Promise(Tuple)

So it's insert. More you can read here: http://tarantool.org/doc/book/box/box_space.html

Promise resolve a new tuple.

upsert(spaceId: Number or String, ops: array of operations, tuple: tuple) : Promise()

About operation: http://tarantool.org/doc/book/box/box_space.html#lua-function.space_object.upsert

Ops: http://tarantool.org/doc/book/box/box_space.html (search for update here).

Promise resolve nothing.

replace(spaceId: Number or String, tuple: tuple) : Promise(Tuple)

So it's replace. More you can read here: http://tarantool.org/doc/book/box/box_space.html

Promise resolve a new or replaced tuple.

call(functionName: String, args...) : Promise(Array or undefined)

Call function with arguments. You can find example at test.

You can create function on tarantool side:

function myget(id)
    val = box.space.batched:select{id}
    return val[1]
end

And then use something like this:

conn.call('myget', 4)
.then(function(value){
    console.log(value);
});

If you have a 2 arguments function just send a second arguments in this way:

conn.call('my2argumentsfunc', 'first', 'second arguments')

And etc like this.

Because lua support a multiple return it's always return array or undefined.

destroy(interupt: Boolean) : Promise

If you call destroy with interupt true it will interupt all process and destroy socket connection without awaiting results. Else it's stub methods with promise reject for future call and await all results and then destroy connection.

##Testing

Now it's poor test just a win to win situation and some hacks before. Install all packages and tarantool on your machine then launch a test through:

$ ./test/box.lua

Then just a use npm test and it will use mocha and launch test.

##Contributions

It's ok you can do whatever you need. I add log options for some technical information it can be help for you. If i don't answer i just miss email :( it's a lot emails from github so please write me to [email protected] directly if i don't answer in one day.

##Changelog

###1.0.0

Fix test for call changes and remove unuse upsert parameter (critical change API for upsert)

###0.4.1

Add clear schema cache on change schema id

###0.4.0

Change msgpack5 to msgpack-lite(thx to @arusakov).
Add msgpack as option for connection.
Bump msgpack5 for work at new version.

###0.3.0 Add upsert operation.
Key is now can be just a number.

##ToDo

Test eval methods and make benchmarks and improve performance.