Getting started with mongoose

Remarks#

Mongoose is a MongoDB object modeling tool designed to work in an asynchronous environment.

Everything in Mongoose starts with a Schema. Each schema maps to a MongoDB collection and defines the shape of the documents within that collection.

Mongoose makes it painlessly easy to work with MongoDB database.

We can easily structure our database using Schemas and Models, Automate certain things when record is added or updated using Middlewares/Hooks and easily get the data we need by querying our models.

Important Links

• Mongoose Quickstart

• Mongoose GitHub Repository

• Mongoose Documentation

• Mongoose Plugins

Versions#

Latest release: Version 4.6.0 released on 2nd September 2016

All versions can be found at https://github.com/Automattic/mongoose/blob/master/History.md

Installation

Installing mongoose is as easy as running the npm command

npm install mongoose --save

But make sure you have also installed MongoDB for your OS or Have access to a MongoDB database.

Connecting to MongoDB database:

1. Import mongoose into the app:

import mongoose from 'mongoose';

2. Specify a Promise library:

mongoose.Promise = global.Promise;

3. Connect to MongoDB:

mongoose.connect('mongodb://127.0.0.1:27017/database');

/* Mongoose connection format looks something like this */
mongoose.connect('mongodb://USERNAME:PASSWORD@HOST::PORT/DATABASE_NAME');

Note:

• By default mongoose connects to MongoDB at port 27017, Which is the default port used by MongoDB.

• To connect to MongoDB hosted somewhere else, use the second syntax. Enter MongoDB username, password, host, port and database name.

MongoDB port is 27017 by default; use your app name as the db name.

Connection with options and callback

Mongoose connect has 3 parameters, uri, options, and the callback function. To use them see sample below.

var mongoose = require('mongoose');

var uri = 'mongodb://localhost:27017/DBNAME';

var options = {
    user: 'user1',
    pass: 'pass'
}

mongoose.connect(uri, options, function(err){
    if (err) throw err;
    // if no error == connected
});