orinabiji-mongoose-records-history v1.0.3

Mongoose History Plugin

Installation

npm install mongoose-history

Or add it to your package.json

Usage

For starting history of your collection, you need to simply add the mongoose-history plugin:

var mongoose        = require('mongoose')
  , mongooseHistory = require('mongoose-history')
  , Schema          = mongoose.Schema

var Post = new Schema({
    title:       String
  , message:     String
  , updated_for: String
})

Post.plugin(mongooseHistory)

This will generate a log from al your changes on this schema.

The plugin will create a new collection with format: originalCollectionName + _history, in example: posts_history. You can also change the name of the collection by setting the configuration customCollectionName:

var options = {customCollectionName: "post_hst"}
Post.plugin(mongooseHistory, options)

The history documents have the format:

{
    _id:  ObjectId,
    t: Date // when history was made
    o: "i" (insert) | "u" (update) | "r" (remove) // what happens with document
    d: {  // changed document data
        _id:         ObjectId
      , title:       String
      , message:     String
      , updated_for: String
    }
}

Indexes

To improve queries perfomance in history collection you can define indexes, for example:

var options = {indexes: [{'t': -1, 'd._id': 1}]};
Post.plugin(mongooseHistory, options)

Send history to another database

You can keep your history collection far away from your primary database or replica set. This can be useful for improve the architecture of your system.

Just create another connection to the new database and link the reference in historyConnection:

var secondConn = mongoose.createConnection('mongodb://localhost/another_conn');
var options = {historyConnection: secondConn}
Post.plugin(mongooseHistory, options)

Store metadata

If you need to store aditionnal data, use the metadata option It accepts a collection of objects. The parameters key and value are required. You can specify mongoose options using the parameter schema (defaults to {type: mongoose.Schema.Types.Mixed}) value can be either a String (resolved from the updated object), or a function, sync or async

var options = {
  metadata: [
    {key: 'title', value: 'title'},
    {key: 'titleFunc', value: function(original, newObject){return newObject.title}},
    {key: 'titleAsync', value: function(original, newObject, cb){cb(null, newObject.title)}}
  ]
};
PostSchema.plugin(history,options);
module.exports = mongoose.model('Post_meta', PostSchema);

Statics

All modules with history plugin have following methods:

Model.historyModel()

Get History Model of Model;

Model.clearHistory()

Clear all History collection;