Node-couch-database-spawner NPM

node-couch-database-spawner

CouchDb database spawner for Node.Js using node-couch

Installation

npm install node-couch-database-spawner --save

NPM package

https://npmjs.com/package/node-couch-database-spawner

Usage

var spawner = require('node-couch-database-spawner'),
        options = {
            databasesPath: './databases/',
            nodeCouch: { // node-couch options
               credentials: {
                   userName: 'user',
                   password: 'pass'
               },
               url: {
                   hostName: 'localhost',
                   port: 5984
               }
           }
        };

spawner.spawn(options);

File/Folder structure

node-couch-database-spawner reads a local file/folder structure to build up database definitions to be spawned. Inside the options.databasesPath it is expected that the file/folder structure is as follows:

DatabaseName: Folder - Can be chosen.
- designs: Folder - Name must be designs.
  - AnyNameDesignDocument.js: File - Design document specification (Node.Js JavaScript format). File name is irrelevant.
  - ... - Any amount.
- documents: Folder - Name must be documents.
  - DocumentType: Folder - Containing documents divided by type. Each document under the folder will be augmented with a type property having the value of the folder name.
    - AnyNameDocument.json: File - Document specification (JSON format). File name is irrelevant.
    - ... - Any amount.
  - ... - Any amount.