couchdb-audit

couchdb-audit

An npm and Kanso module for auditing changes to couchdb documents.

Node

Install

npm install couchdb-audit

Include

Nano

var audit = require('couchdb-audit').withNano(db, dbName, designName, user)

• db: a Nano module
• dbName: the name of the database to use
• designName: the name of the design document to use
• user: a String or callback which fetches the username

You can also optionally pass in a separate db name for storing and retrieving audit documents.

var audit = require('couchdb-audit').withNano(db, dbName, auditDbName, designName, user)

Felix

var audit = require('couchdb-audit').withFelix(db, user)

• db: a Felix CouchDB module
• user: a String or callback which fetches the username

You can also optionally pass in a separate db name for storing and retrieving audit documents.

var audit = require('couchdb-audit').withFelix(db, auditDb, user)

Kanso

Install

Include "couchdb-audit": null in your kanso.json.

Include

var audit = require('couchdb-audit/kanso').withKanso(db)

Where db is a Kanso DB module.

You can also optionally pass in a separate db name for storing and retrieving audit documents.

var audit = require('couchdb-audit/kanso').withKanso(db, auditDb)

Usage

Then call saveDoc, bulkSave, removeDoc, get, or log.

Caveat

This package is in its infancy, use with caution.

Development

Publishing

kanso publish npm publish

Testing

grunt test for the Node implementation. Deploy to kanso to run the kanso tests.

Build Status

Builds brought to you courtesy of Travis CI.