How to include external models in mongoose?

In Mongoose, if you want to reference another model within your model, you can achieve this by using the ref keyword in MongoDB. This approach is commonly used to establish relationships between models, such as one-to-many or many-to-many relationships. Here is a specific step-by-step guide and code example:

Steps

1. Define the referenced model: First, you need to have a Mongoose model already defined that will be referenced by other models.

2. Set up the Schema in the referencing model: In the Schema definition of another model, use ref to specify the name of the model to associate with.

3. Use the populate method: When querying the database, use the populate() method to fill in the associated data.

Example

Assume we have two models: the User model and the Post model. The Post model references the User model to specify the author of each post.

Step 1: Define the User model

javascript
const mongoose = require('mongoose');
const Schema = mongoose.Schema;

const userSchema = new Schema({
    name: { type: String, required: true },
    email: { type: String, required: true }
});

const User = mongoose.model('User', userSchema);

Step 2: Define the Post model and reference User

javascript
const postSchema = new Schema({
    title: { type: String, required: true },
    content: { type: String, required: true },
    author: { type: Schema.Types.ObjectId, ref: 'User' }
});

const Post = mongoose.model('Post', postSchema);

In the Post model, the author field is defined as an ObjectId and uses the ref keyword to reference the User model. This indicates that the author field in each Post document will store the ID of a User document.

Step 3: Use populate

When you need to retrieve posts along with their author details, you can do the following:

javascript
Post.find().populate('author').exec((err, posts) => {
    if (err) throw err;
    console.log(posts);
});

This code queries all posts and populates the author field with the related user information, so the posts array returned will contain complete user objects rather than just user IDs.

With this approach, Mongoose makes it simple and intuitive to establish and manipulate relationships between documents.