Mongoose MongoDB ODM
Mongoose is a MongoDB object modeling tool designed to work in an asynchronous environment.
Check out the plugins search site to see hundreds of related modules from the community.
Build your own Mongoose plugin through generator-mongoose-plugin.
$ npm install mongoose
The current stable branch is master. The 3.8.x branch contains legacy support for the 3.x release series, which is no longer under active development as of September 2015. The 3.8.x docs are still available.
First, we need to define a connection. If your app uses only one database, you should use
mongoose.connect. If you need to create additional connections, use
createConnection take a
mongodb:// URI, or the parameters
host, database, port, options.
var mongoose = require'mongoose';mongooseconnect'mongodb://localhost/my_database';
Once connected, the
open event is fired on the
Connection instance. If you're using
mongoose.createConnection return value is a
Note: If the local connection fails then try using 127.0.0.1 instead of localhost. Sometimes issues may arise when the local hostname has been changed.
Important! Mongoose buffers all the commands until it's connected to the database. This means that you don't have to wait until it connects to MongoDB in order to define models, run queries, etc.
Models are defined through the
var Schema = mongooseSchemaObjectId = SchemaObjectId;var BlogPost =author : ObjectIdtitle : Stringbody : Stringdate : Date;
Aside from defining the structure of your documents and the types of data you're storing, a Schema handles the definition of:
The following example shows some of these features:
var Comment =name: type: String default: 'hahaha'age: type: Number min: 18 index: truebio: type: String match: /[a-z]/date: type: Date default: Datenowbuff: Buffer;// a setterCommentpath'name'setreturn capitalizev;;// middlewareCommentpre'save'notifythisget'email';next;;
Take a look at the example in
examples/schema.js for an end-to-end example of a typical setup.
Once we define a model through
mongoose.model('ModelName', mySchema), we can access it through the same function
var myModel = mongoosemodel'ModelName';
Or just do it all at once
var MyModel = mongoosemodel'ModelName' mySchema;
The first argument is the singular name of the collection your model is for. Mongoose automatically looks for the plural version of your model name. For example, if you use
var MyModel = mongoosemodel'Ticket' mySchema;
Then Mongoose will create the model for your tickets collection, not your ticket collection.
Once we have our model, we can then instantiate it, and save it:
var instance = ;instancemykey = 'hello';instancesave//;
Or we can find documents from the same collection
You can also
update, etc. For more details check out the docs.
Important! If you opened a separate connection using
mongoose.createConnection() but attempt to access the model through
mongoose.model('ModelName') it will not work as expected since it is not hooked up to an active db connection. In this case access your model through the connection you created:
var conn = mongoosecreateConnection'your connection string'MyModel = connmodel'ModelName' schemam = ;msave; // works
var conn = mongoosecreateConnection'your connection string'MyModel = mongoosemodel'ModelName' schemam = ;msave; // does not work b/c the default connection object was never connected
In the first example snippet, we defined a key in the Schema that looks like:
Comment is a
Schema we created. This means that creating embedded documents is as simple as:
// retrieve my modelvar BlogPost = mongoosemodel'BlogPost';// create a blog postvar post = ;// create a commentpostcommentspush title: 'My comment' ;postsaveif !err console.log'Success!';;
The same goes for removing them:
BlogPostfindByIdmyIdif !errpostcomments0remove;postsave// do something;;
Embedded documents enjoy all the same features as your models. Defaults, validators, middleware. Whenever an error occurs, it's bubbled to the
save() error callback, so error handling is a snap!
See the docs page.
You can intercept method arguments via middleware.
For example, this would allow you to broadcast changes about your Documents every time someone
sets a path in your Document to a new value:
schemapre'set'// `this` is the current Documentthisemit'set' path val;// Pass control to the next prenext;;
Moreover, you can mutate the incoming
method arguments so that subsequent middleware see different values for those arguments. To do so, just pass the new values to
premethod// Mutate methodArg1next"altered-" + methodArg1toString methodArg2;;// pre declaration is chainablepremethodconsole.logmethodArg1;// => 'altered-originalValOfMethodArg1'console.logmethodArg2;// => 'originalValOfMethodArg2'// Passing no arguments to `next` automatically passes along the current argument values// i.e., the following `next()` is equivalent to `next(methodArg1, methodArg2)`// and also equivalent to, with the example method arg// values, `next('altered-originalValOfMethodArg1', 'originalValOfMethodArg2')`next;;
type, when used in a schema has special meaning within Mongoose. If your schema requires using
type as a nested property you must use object notation:
broken: type: Booleanasset :name: Stringtype: String // uh oh, it broke. asset will be interpreted as String;works: type: Booleanasset:name: Stringtype: type: String // works. asset is an object with a type property;
Mongoose is built on top of the official MongoDB Node.js driver. Each mongoose model keeps a reference to a native MongoDB driver collection. The collection object can be accessed using
YourModel.collection. However, using the collection object directly bypasses all mongoose features, including hooks, validation, etc.
Copyright (c) 2010 LearnBoost <firstname.lastname@example.org>
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.