couchpenter

CouchDB database and document setup tool.

npm install couchpenter
34 downloads in the last week
68 downloads in the last month

Couchpenter Build Status Dependencies Status

Avatar

Couchpenter is a CouchDB database and document setup tool.

This is handy when you want to create or delete CouchDB databases and documents based on a predefined setup file, either from the command-line or programmatically.

A common usage scenario is to hook up Couchpenter to application start up code, ensuring CouchDB to have the required databases along with any data, design, and replication documents, before the server starts listening.

Another usage is for integration testing, either from test libraries (e.g. Mocha's beforeEach/afterEach), or from a Continuous Integration build pipeline (e.g. resetting the databases prior to running the test suites).

Installation

npm install -g couchpenter 

Usage

Create a sample couchpenter.json setup file:

couchpenter init

Execute a task against a CouchDB URL using default couchpenter.json setup file:

couchpenter <task> -u http://user:pass@host:port

CouchDB URL can also be set via COUCHDB_URL environment variable:

(*nix)

export COUCHDB_URL=http://user:pass@host:port

(Windows)

set COUCHDB_URL=http://user:pass@host:port

Execute a task using custom setup file:

couchpenter <task> -u http://user:pass@host:port -f somecouchpenter.json

Tasks:

TaskDescription
setupCreate databases and documents, overwrite if documents exist.
setup-dbCreate databases only.
setup-doc Create documents only, does not overwrite if exist.
setup-doc-overwriteCreate documents only, overwrite if exist.
teardownAlias for teardown-db.
teardown-dbDelete databases.
teardown-docDelete documents.
resetAlias for reset-doc.
reset-dbDelete then recreate databases and documents.
reset-docDelete then recreate documents only.
cleanAlias for clean-db.
clean-dbDelete unknown databases (not configured in setup file).
warm-viewWarm up views specified in design documents.

Programmatically:

// use default couchpenter.json setup file
var couchpenter = new (require('couchpenter'))(
  'http://user:pass@host:port'
);

// use custom setup file
var couchpenter = new (require('couchpenter'))(
  'http://user:pass@host:port',
  { setupFile: 'somecouchpenter.json' }
);

// use setup object (instead of setup file)
var couchpenter = new (require('couchpenter'))(
  'http://user:pass@host:port',
  { dbSetup: {
      "db1": [
        { "_id": "doc1", "foo": "bar" },
        { "_id": "doc2", "foo": "bar" },
        "path/to/doc3file.json"
      ]
    }
  }
);

// prefix the database names
// handy for running multiple tests in parallel without interrupting each other
var couchpenter = new (require('couchpenter'))(
  'http://user:pass@host:port',
  { prefix: 'testrun123_' }
);

// specify a base directory for the documents specified in setup file
var couchpenter = new (require('couchpenter'))(
  'http://user:pass@host:port',
  { dir: '../some/dir/' }
);

// set up databases and documents
couchpenter.setUp(function (err, results) {
});

// delete databases and documents
couchpenter.tearDown(function (err, results) {
});

// delete databases and documents, then set up databases and documents
couchpenter.reset(function (err, results) {
});

// delete documents, then set up documents
couchpenter.resetDocuments(function (err, results) {
});

// warm up all views specified in design documents
couchpenter.warmViews(function (err, results) {
});

// warm up all views specified in design documents every minute (scheduled)
couchpenter.warmViews('* * * * *', function (err, results) {
});

Check out lib/couchpenter for other available methods.

Configuration

Couchpenter setup file is just a simple JSON file:

{
  "db1": [
    { "_id": "doc1", "foo": "bar" },
    { "_id": "doc2", "foo": "bar" },
    "path/to/doc3file.json"
  ],
  "db2": [
    { "_id": "doc4", "foo": "bar" },
    "path/to/modulename"
  ],
  "db3": [],
  "_replicator": {
    {
      "_id": "db1_pull",
      "source": "http://user:pass@remotehost:5984/db1",
      "target": "db1",
      "user_ctx": {
        "name": "user",
        "roles": ["_admin"]
      },
      "continuous": true
    }
  }
}

Property keys are the names of the databases, property values are the documents in each database.

A document can be represented as:

  • an object
  • a file path string containing a JSON document, file name must end with .json
  • a module path string

Paths are relative to current directory if it's used from command-line, or relative to opts.dir if it's used programmatically (defaults to current directory if opts.dir is not specified).

npm loves you