Mongoose version

Mongoose version is a mongoose plugin to save document data versions. Documents are saved to a "versioned" document collection before saving.

Installation

npm install @trejgun/mongoose-version

Usage

To use mongoose-version for an existing mongoose schema you'll have to require and plugin @trejgun/mongoose-version into the existing schema.

The following schema definition defines a "Page" schema, and uses @trejgun/mongoose-version plugin with default options

import {Schema} from 'mongoose';
import version from '@trejgun/mongoose-version';

const Page = new Schema({
    title : { 
        type : String, 
        required : true
    },
    content : { 
        type : String, 
        required : true 
    },
    tags : [String],
});

Page.plugin(version);

Mongoose-version will define a schema that has a refId field pointing to the original model and a version array containing cloned copies of the backed up model.

Mongoose-version will add a static field to Page, that is "VersionedModel" that can be used to access the versioned model of page, for example for querying old versions of a document.

Option keys and defaults

• collection: name of the collection to persist versions to. The default is 'versions'. You should supply this option if you're using mongoose-version on more than one schema.
• suppressVersionIncrement: mongoose-version will not increment the version of the saved model before saving the model by default. To turn on auto version increment set this option to false. Default: true
• mongoose: Pass a mongoose instance to work with
• removeVersions: Removes versions when origin document is removed. Defaults to false
• Options are passed to a newly created mongoose schemas as settings, so you may use any option supported by mongoose

In case you only want to specify the collection name, you can pass a string instance to options that is taken as collection name. Options may be passed as follows:

Page.plugin(version, { collection: 'Page__versions' });

Debug Messages

Mongoose-version uses the debug module for debug messages. You can enable mongoose-version debug logs by setting the DEBUG environment variable to mongoose:version.

DEBUG=mongoose:version

Debug messages are logged if a version was persisted to mongodb or a version was removed from mongodb.