giraffi/node-orchestrate.io

A client implementation for Orchestrate.io in Node.js

node-orchestrate.io

A client implementation for Orchestrate.io in Node.js

Setup

Require orchestrate.io and create a new object with your api_key:

io = require('orchestrate.io')
miao = io.createClient({
  apikey: 'Your-API-key'
});

Or

$ export ORCHESTRATE_IO_APIKEY=Your-API-key
$ node
> io = require('orchestrate.io')
> miao = io.createClient;

And

var data = { "Title": "Rashomon" }
var queryString = 'Genre:myth'

Usage

Key/Value

Get

Gets the latest value assigned to a key.

miao
  .getKeyValue({
    collection: 'films',
    key: 'kurosawa'
  },
  function (err, data) {
    console.log(data);
  });

Put

Creates or updates the value at the collection/key specified.

miao
  .putKeyValue({
    collection: 'films',
    key: 'kurosawa',
    data: data
  },
  function (err, data) {
    console.log(data);
  });

Search

Returns list of items matching the lucene query.

miao
  .search({
    collection: 'films',
    query: 'Genre:crime'
  },
  function (err, data) {
    console.log(data);
  });

Events

Get

Returns a list of events, optionally limited to specified time range in reverse chronological order.

miao
  .getEvent({
    collection: 'films',
    key: 'kurosawa',
    type: 'comments',
    start: 1388051827,
    end: 1388051845,
  },
  function (err, data) {
    console.log(data);
  });

Put

Puts an event with an optional user defined timestamp.

miao
  .putEvent({
    collection: 'films',
    key: 'kurosawa',
    type: 'comments',
    data: { note: "Magnifique!" },
    timestamp: 1388051845
  },
  function (err, data) {
    console.log(data);
  });

Graph

Get

Returns relation’s collection, key, ref, and values.

miao
  .getGraph({
    collection: 'films',
    key: 'kurosawa',
    relation: 'princess_mononoke',
  },
  function (err, data) {
    console.log(data);
  });

Put

Creates a relationship between two objects. Relations can span collections.

miao
  .putGraph({
    collection: 'films',
    key: 'kurosawa',
    relation: 'samurai',
    toCollection: 'films',
    toKey: 'preincess_mononoke'
  },
  function (err, data) {
    console.log(data);
  });

Test

Run npm test or make test to test all.

$ make test