ANNOUNCEMENTVoyage AI joins MongoDB to power more accurate and trustworthy AI applications on Atlas. Learn more >Voyage AI joins MongoDB to power more accurate and trustworthy AI applications on Atlas. >>

NEWSLearn why MongoDB was named a leader in the 2024 Gartner® Magic Quadrant™ Read the report >Learn why MongoDB was named a leader in the 2024 Gartner® Magic Quadrant™ >>

NEWMongoDB 8.0: Experience unmatched speed and performance. Check it out >MongoDB 8.0: Experience unmatched speed and performance. >>

SUPPORT

Mongoose ODM Support on MongoDB

Get expert support for Mongoose object data modeling (ODM) with MongoDB.

Get Started

Download Mongoose

Expert guidance

Get best-in-class guidance and troubleshooting for Mongoose from MongoDB Support. Support for Mongoose comes at no additional cost for customers using dedicated clusters (M10+) on MongoDB Atlas.

Clear escalation paths

Established support agreements and escalation paths between MongoDB and Mongoose mean you’ll never bounce back and forth between organizations searching for answers.

Technical vetting of Mongoose releases

MongoDB’s team of experts rigorously tests new Mongoose releases to ensure they are compatible with MongoDB and meet appropriate performance benchmarks.

Mongoose Features

Schemas to structure your data

Mongoose schemas map to your MongoDB collections and documents to create a structure for your data.

Customizable validation

Mongoose comes with built-in validators and the option to create custom validators and error messages.

Additional helper methods

Mongoose comes with a variety of helper methods for CRUD operations and queries.

Middleware functions

Middleware functions in Mongoose let you run certain functions automatically before or after specific actions.

How to get started with Mongoose and MongoDB

Although you’re not required to use an ODM like Mongoose with MongoDB, it can help with data modeling. To get started with Mongoose, check out the following tutorial and code snippets.

Get Started

Structure your MongoDB data

Write your Mongoose schema, which maps to your MongoDB collection and documents and helps define your data model.

Establish validation rules

Define which fields are required in your MongoDB documents with Mongoose.

Structure your MongoDB data

Write your Mongoose schema, which maps to your MongoDB collection and documents and helps define your data model.

Schema and Model

Code Snippet

xxxxxxxxxx
 
import mongoose from 'mongoose';const { Schema, model } = mongoose;​const yourSchema = new Schema({  field1: String, // Name your data type here (“String”, etc)  field2: Boolean,  meta_field2: [{    field3: Number,    field4: String,  }]  field5: Date,});​const yourSchema = model('Schema', yourSchema);export default Schema;

Establish validation rules

Define which fields are required in your MongoDB documents with Mongoose.

Validation

Code Snippet

xxxxxxxxxx
 
const yourSchema = new Schema({  field1:  {    type: String,    required: true, // Define whether fields are required or not    lowercase: true, // Define if string needs to be upper or lower case  },  field2:  {    type: Boolean,    default: false, // Define field default setting   },  meta_field2: [{    field3: Number,    field4: String,  }] field5:  {    type: Date,    immutable: true, // Make this field impossible to change later  },});

Schema and Model

Code Snippet

xxxxxxxxxx
 
import mongoose from 'mongoose';
const { Schema, model } = mongoose;
​
const yourSchema = new Schema({
  field1: String, // Name your data type here (“String”, etc)
  field2: Boolean,
  meta_field2: [{
    field3: Number,
    field4: String,
  }]
  field5: Date,
});
​
const yourSchema = model('Schema', yourSchema);
export default Schema;

Resources

Learn more about working with MongoDB and Mongoose.

Get started with MongoDB and Mongoose

Explore how to use MongoDB with Mongoose to structure your data with ease.

The Mongoose ODM with Val Karpov

Why do developers love Mongoose? Listen to the MongoDB Podcast and hear from Val Karpov, the Mongoose ODM maintainer.

Listen now

Comparing Mongoose

Compare using MongoDB against using the MongoDB Node.js driver.

Use Mongoose with MongoDB on Atlas today

Get started in seconds. Our free clusters come with 512 MB of storage so you can play around with sample data and get oriented with our platform.

Try Free

GET STARTED FOR FREE WITH:

95+ regions worldwide
Sample data sets
Always-on authentication
End-to-end encryption
Command line tool