Keeps a history of all changes of a document.
npm install mongoose-history
Keeps a history of all changes of a document.
``bash`
npm install mongoose-history
Or add it to your package.json
For starting history of your collection, you need to simply add the mongoose-history plugin:
`javascript
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:
`javascript`
var options = {customCollectionName: "post_hst"}
Post.plugin(mongooseHistory, options)
The history documents have the format:
`javascript`
{
_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
}
}
`javascript`
var options = {indexes: [{'t': -1, 'd._id': 1}]};
Post.plugin(mongooseHistory, options)
Just create another connection to the new database and link the reference in __historyConnection__:
`javascript`
var secondConn = mongoose.createConnection('mongodb://localhost/another_conn');
var options = {historyConnection: secondConn}
Post.plugin(mongooseHistory, options)
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`javascript
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);
`$3
All modules with history plugin have following methods:#### Model.historyModel()
Get History Model of Model;
#### Model.clearHistory()
Clear all History collection;
Development
$3
The tests run against a local mongodb installation and use the following databases:
and mongoose-history-test-second.Custom connection uris can be provided via environment variables for e.g. using a username and password:
`
CONNECTION_URI='mongodb://username:password@localhost/mongoose-history-test' SECONDARY_CONNECTION_URI='mongodb://username:password@localhost/mongoose-history-test-second' mocha
Copyright (c) 2013-2016, Nassor Paulino da Silva
All rights reserved.
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.