Introduction to Mongoose Autopopulate Plugin

Mongoose Autopopulate is a powerful plugin that simplifies the process of automatically populating referenced documents in MongoDB using Mongoose. By adding this plugin to your schemas, you can ensure that the referenced documents are automatically fetched without having to call the populate method explicitly.

Getting Started

To begin using mongoose-autopopulate, install the plugin via npm:

  npm install mongoose-autopopulate

Basic Setup

Here’s a simple example to demonstrate how to use mongoose-autopopulate in your schemas:

  
    const mongoose = require('mongoose');
    const autopopulate = require('mongoose-autopopulate');
   
    const AuthorSchema = new mongoose.Schema({
      name: String
    });
   
    const BookSchema = new mongoose.Schema({
      title: String,
      author: {
        type: mongoose.Schema.Types.ObjectId,
        ref: 'Author',
        autopopulate: true
      }
    });
   
    AuthorSchema.plugin(autopopulate);
    BookSchema.plugin(autopopulate);
   
    const Author = mongoose.model('Author', AuthorSchema);
    const Book = mongoose.model('Book', BookSchema);
   
    async function createBook() {
      const author = await Author.create({ name: 'John Doe' });
      const book = await Book.create({ title: 'Autopopulate with Mongoose', author: author._id });
      const populatedBook = await Book.findById(book._id).exec();
      console.log(populatedBook);
    }
   
    createBook();
  

Advanced Usage

With mongoose-autopopulate, you can specify more advanced configurations, such as:

Autopopulate Select Fields

Limit the fields to be populated:

  
    const BookSchema = new mongoose.Schema({
      title: String,
      author: {
        type: mongoose.Schema.Types.ObjectId,
        ref: 'Author',
        autopopulate: { select: 'name' }
      }
    });
    BookSchema.plugin(autopopulate);
  

Autopopulate Maximum Depth

Control the maximum population depth:

  
    const BookSchema = new mongoose.Schema({
      title: String,
      author: {
        type: mongoose.Schema.Types.ObjectId,
        ref: 'Author',
        autopopulate: { maxDepth: 2 }
      }
    });
    BookSchema.plugin(autopopulate);
  

Complete Application Example

Now, let’s look at how to create an entire application using mongoose-autopopulate:

  
    const express = require('express');
    const mongoose = require('mongoose');
    const autopopulate = require('mongoose-autopopulate');
    
    const app = express();
    
    mongoose.connect('mongodb://localhost/autopopulate_demo', { useNewUrlParser: true, useUnifiedTopology: true });
    
    const AuthorSchema = new mongoose.Schema({
      name: String
    });
    
    const BookSchema = new mongoose.Schema({
      title: String,
      author: {
        type: mongoose.Schema.Types.ObjectId,
        ref: 'Author',
        autopopulate: true
      }
    });
    
    AuthorSchema.plugin(autopopulate);
    BookSchema.plugin(autopopulate);
    
    const Author = mongoose.model('Author', AuthorSchema);
    const Book = mongoose.model('Book', BookSchema);
    
    app.get('/books', async (req, res) => {
      const books = await Book.find({});
      res.json(books);
    });
    
    app.post('/books', async (req, res) => {
      const author = await Author.create({ name: 'Jane Doe' });
      const book = await Book.create({ title: 'Mongoose Autopopulate in Action', author: author._id });
      res.json(book);
    });
    
    app.listen(3000, () => {
      console.log('Server is running on port 3000');
    });
    
    async function init() {
      await Author.deleteMany({});
      await Book.deleteMany({});
      await app.post('/books');
    }
    
    init();
  

With this application running, you can see how mongoose-autopopulate can streamline data retrieval and populating related documents.

Hash: 7f0a07ed836f15e231fd5b82ec2e986e9993f265a898cd0e817cd2655ae7218a