Skip to content

Latest commit

 

History

History
136 lines (113 loc) · 4.48 KB

README.md

File metadata and controls

136 lines (113 loc) · 4.48 KB
Raw

couch-daemon

High-level sugar for CouchDBs os_daemon. With a Highland streaming interface.

Build Status

Usage

couch-daemon provides high-level interface as well as low-level streams. couch-daemon is built as a pipeline of six streams:

_.pipeline(
  //Create a stream of databases, filtered via black- and white lists.
  dbs(couch, opts),
  // Fetch and emit design docs.
  ddocs(couch, opts),
  // Create a global stream of changes.
  changes(couch, opts),
  // Compile functions defined in ddocs.
  compile(couch, opts),

  your_worker(couch, opts),

  // Store last seq in checkpoint docs.
  checkpoint(couch, opts),
  // Print log events.
  logger(couch, opts)
);

he idea is to store per database daemon configuration in design documents in an object under the daemon name. The configuration cana have functions, like filters or processors (see couchmagick and massage-couch). couch-daemon looks at those configurations and evaluates each function in a sandbox. The actual daemon code is modelled as through stream. It receives configuration as well as changes of each database it is configured for. You can do anything you want inside that stream - make http calls to the outside, query the database or run long computations. When you're done you emit the original event to have couch-daemon store the checkpoint. Do not hesitate to open a ticket if something is unclear - this was written a bit in a hussle.

When using the high-level interface you do not need to handle os_daemon communication with CouchDB, commandline option parsing nor set up the pipeline yourself. Just call couch-daemon with (optional) defaults and your worker stream and you're fine:

require('couch-daemon')({ include_docs: true }, functions(url, options) {
  // url comes from daemon configuration,
  // as well as the options

  return function(source) {
    return source
      .filter...
      .group...
      .zip...
      .whatever...
  };
});

Logging

The last stream in the couch-daemon pipeline is one that logs either to CouchDB's log or, when running in CLI mode, prints to console.

You can instruct the logger to respect your message by emitting a special log event from your worker stream:

{
  type: 'log',
  level: 'debug',  // Default is 'info'. Also possible: 'error'
  message: 'And the stars look very different today'
}

See examples/logger.js for a concrete example.

Configuration

The daemon is set up in the os_daemons config section (eg. in local.ini):

[os_daemons]
mydaemon = mydaemon

The actual configuration is done under its own config section:

[mydaemon]
; Optional username and password, used by the workers to access the database
username = mein-user
password = secure
; Only documents in the databases below are processed (separate with comma).
; Regular expressions are allowed:
;whitelist = mydb,otherdb,/^special-.*/
; Ignore the following databases (again comma separated list)
; Regular expressions are again allowed:
blacklist = /^_/

Commandline

couch-daemon makes it easy to test your daemon via commandline. couch-daemon detects if it has been started interactively. (Use --daemon argument for testing CouchDB os daemon interaction.)

When running interactively couch-daemon parses commandline options and prints out log messages to console.

Daemons in the wild

Send me a pull to add yours.

Examples

An example daemon is included. It just prints out each change in all dbs:

./examples/logger.js --name my-daemon --blacklist _users

Contributing

Write tests with tap, then test your code with npm test.

Specify CouchDB url and credentials via COUCH environment variable:

COUCH=http://user:password@localhost:5984 npm test

License

Copyright (c) 2014 Johannes J. Schmidt, null2 GmbH
Licensed under the MIT license.