Orchestrate-CouchDB

Pipe CouchDB changes into Orchestrate.io, to effortlessly add a search, events, and relations API.

Install

npm install orchestrate-couchdb

Usage

var OrchestrateCouchDB = require('orchestrate-couchdb');

var importer = OrchestrateCouchDB({
  orchestrate: {
    api_key: 'your_orchestrate_api_key'
  },
  couchdb: {
    url: 'http://localhost:5984',
    username: 'bobross',
    password: 'happylittletrees',
    database: 'joy-of-painting'
  },
  map: function (doc) {
    doc.hello = 'world';
    return doc;
  }
});

importer.on('change.success', console.log);

Now whenever the importer successfully writes a document to Orchestrate, it will print a message.

Need to pre-process your data? The map option can contain a function that modifies each document before it gets saved.

Using as a Daemon

You can also run orchestrate-couchdb as a daemon, so it will continue watching your CouchDB node autonomously. To start the web server, just do:

sudo npm install -g orchestrate-couchdb
export ORCHESTRATE_API_KEY=...
export COUCHDB_URL=...
export COUCHDB_USERNAME=...
export COUCHDB_PASSWORD=...
export COUCHDB_DATABASE=...
orchestrate-couchdb
# Now listening to [database]

Now the importer is syncing changes from CouchDB to Orchestrate.io.

Usage on Heroku

To deploy orchestrate-couchdb on Heroku, you'll need the [heroku toolbelt][]. Then:

git clone [email protected]:orchestrate-io/orchestrate-couchdb.git
cd orchestrate-couchdb
heroku create [app-name]
heroku config:set ORCHESTRATE_API_KEY=...
heroku config:set COUCHDB_URL=...
heroku config:set COUCHDB_USERNAME=...
heroku config:set COUCHDB_PASSWORD=...
heroku config:set COUCHDB_DATABASE=...
git push heroku master

Now your app is running on Heroku! To prevent it from idling, scale the process to use two dynos:

heroku ps:scale worker=1 web=0

Options

orchestrate-couchdb takes one argument, an options object. It takes the following arguments, and has the following defaults:

{  
  orchestrate: {
    api_key: process.env.ORCHESTRATE_API_KEY
  },
  couchdb: {
    url: process.env.COUCHDB_URL || 'http://localhost:5984',
    username: process.env.COUCHDB_USERNAME,
    password: process.env.COUCHDB_PASSWORD,
    database: process.env.COUCHDB_DATABASE
  }
}

You can set many of these options as environment variables, or you can pass them directly:

var OrchestrateCouchDB = require('orchestrate-couchdb');

var importer = new OrchestrateCouchDB({
  orchestrate: {
    api_key: 'your_orchestrate_api_key'
  },
  couchdb: {
    url: 'http://localhost:5984',
    username: 'bobross',
    password: 'happylittletrees',
    database: 'joy-of-painting'
  }
});

Events

• connect: When the watcher begins listening, but before any changes are received.
• change: Emitted whenever processing a change starts, succeeded, and errors out.
• change.start: Detected a change in CouchDB.
• change.success: Writing a document to Orchestrate.io succeeded!
• change.error: Writing a document to Orchestrate.io failed due to an error.
• error: The connection to CouchDB experienced an error.
• drain: The queue has run out of changes to process.

Tests

npm test

License

ISC, yo.