| Task | Description |
|---|
| setup | Create databases and documents, overwrite if documents exist. |
| setup-db | Create databases only. |
| setup-doc | Create documents only, does not overwrite if exist. |
| setup-doc-overwrite | Create documents only, overwrite if exist. |
| teardown | Alias for teardown-db. |
| teardown-db | Delete databases. |
| teardown-doc | Delete documents. |
| reset | Alias for reset-doc. |
| reset-db | Delete then recreate databases and documents. |
| reset-doc | Delete then recreate documents only. |
| clean | Alias for clean-db. |
| clean-db | Delete unknown databases (not configured in setup file). |
| warm-view | Warm 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](https://github.com/cliffano/couchpenter/blob/master/lib/couchpenter.js) 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).
Colophon
--------
[Developer's Guide](http://cliffano.github.io/developers_guide.html#nodejs)
Build reports:
* [Code complexity report](http://cliffano.github.io/couchpenter/complexity/plato/index.html)
* [Unit tests report](http://cliffano.github.io/couchpenter/test/buster.out)
* [Test coverage report](http://cliffano.github.io/couchpenter/coverage/buster-istanbul/lcov-report/lib/index.html)
* [Integration tests report](http://cliffano.github.io/couchpenter/test-integration/cmdt.out)
* [API Documentation](http://cliffano.github.io/couchpenter/doc/dox-foundation/index.html)
Related Projects:
* [couchtato](http://github.com/cliffano/couchtato) - CouchDB documents iterator tool
---
_Source: https://npm.io/package/couchpenter · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
[](http://travis-ci.org/cliffano/couchpenter)
[](http://david-dm.org/cliffano/couchpenter)
[](https://coveralls.io/r/cliffano/couchpenter?branch=master)
[](http://www.npmjs.com/package/couchpenter)