mvc-express-mongoose

mvc-express-mongoose

This is a Mongoose model loader for mvc-express.

Usage

const config = require('../config');

const mvc = require('mvc-express');
const modelLoader = require('mvc-express-mongoose')(config);


mvc.boot({
    root: __dirname,
    modelLoader
})

Config

The config object should include the following values for the current environment. Below is an example for the development environment:

let config = {
    development: {
        db: {
            endpoint: String, // 'mongodb://username:password@host:port/database',
        },
        use_env_variable: Boolean, // defaults to false. If true, `process.env` is used to extract the configs.
        env_variable: String // the property from `process.env` that will be used to extract the db connection 
    }
}

The current environment is taken form process.env.NODE_ENV. If this is absent, the environment defaults to development.

Creating models

Each model file will receive as arguments: db, services, and options. The db param will include the properties mongoose, and models, which is a reference to all other models in the project.

You can access the connection via db.mongoose.connection

Here is a sample model:

'use strict';

module.exports = TestModel;

function TestModel(db, services, options) {
    let modelName = 'TestModel',
        collectionName = 'testCollection',
        schema = {
            fields: {
                fieldOne: {type: String},
                fieldTwo: {type: 'int'}
            },
            slug: {type: String},
            meta: {
                type: {type: db.mongoose.Schema.ObjectId, ref: 'content'},
                node: {type: db.mongoose.Schema.ObjectId, ref: 'nodes'},
                lastmodified: {type: Date, default: Date.now},
                created: {type: Date, default: Date.now},
                typelabel: {type: String},
                labelfield: {type: String}
            }
        };

    return db.mongoose.connection.model(
        modelName, // db[modelName] will be available for use
        new db.mongoose.Schema(schema, {collection: collectionName})
    );
}

See the mongoose docs for more info.