what does populate in mongoose mean?

Question

I came across the following line of code which I couldn't understand ,although there are lot of tutorials that gives information related to examples of populate but there is none that explains what exactly it means.Here is a example

var mongoose = require('mongoose'), Schema = mongoose.Schema

var PersonSchema = new Schema({
  name    : String,
  age     : Number,
  stories : [{ type: Schema.ObjectId, ref: 'Story' }]
});

var StorySchema = new Schema({
  _creator : {
     type: Schema.ObjectId,
     ref: 'Person'
  },
  title    : String,
  fans     : [{ type: Schema.ObjectId, ref: 'Person' }]
});

var Story  = mongoose.model('Story', StorySchema);
var Person = mongoose.model('Person', PersonSchema);
Story.findOne({ title: /Nintendo/i }).populate('_creator') .exec(function (err, story) {
if (err) ..
  console.log('The creator is %s', story._creator.name);
  // prints "The creator is Aaron"
})

Answer 1

populate() function is mongoose is used for populating the data inside the reference. In your example StorySchema is having _creator field which will reference to the _id field which is basically the ObjectId by of the mongodb document.

populate() function can accept a string or an object as an input.

Where string is the field name which is required to be populated. In your case that is _creator. After mongoose found one doc from mongodb and the result of that is like below

_creator: {
  name: "SomeName",
  age: SomeNumber,
  stories: [Set Of ObjectIDs of documents in stories collection in mongodb]
},
title: "SomeTitle",
fans: [Set of ObjectIDs of documents in persons collection in mongodb]

populate can also accept the object as an input.

You can find the documents of populate() function of mongoose below. http://mongoosejs.com/docs/2.7.x/docs/populate.html

Answer 2

I came across that question randomly, but I feel I need to help here, even if it's old because I'm not convinced by the way it is explained :

Populate() function populate...

That might be very clear for natives English speaker, but maybe not for others.

TL;DR

Populate will automatically replace the specified path in the document, with document(s) from other collection(s)

Long version

Let's take your example

Story.findOne({ title: Nintendo })

Will return a Story of that kind :

{
  _creator : A0jfdSMmEJj*9, //id of the creator (totaly random, just for a clear example)
    title    : Nintendo,
    fans     : [r432i900fds09809n, fdsjifdsjfueu88] // again, totaly random that i've typed here
  }
}

In some case, those kind of request would be enough, because we don't care about the author or the fans so, having some ID won't bother us much.

But in the case where i need that author, i'll need to make another request to find it in database. Except, that here in mongoose we have a clever function called populate() that we can chained to our previous request in order to directly get that information in our answer without explictly doing an additional request.

Story.findOne({ title: Nintendo }).populate('_creator')

will return

{
  _creator : {
       _id : A0jfdSMmEJj*9,
       name: Sai,
       age: 100,
       stories : [fdsfdsfdsew38u, 89hr3232, ...]
    },
    title    : Nintendo,
    fans     : [r432i900fds09809n, fdsjifdsjfueu88]
  }
}

But maybe, that's too much information, and we don't want the stories that he wrote and his age and name are enough. Populate can then take an other argument containing the field that we need

Story.findOne({ title: Nintendo }).populate('_creator', 'name age')

result ==>

{
  _creator : {
       name: Sai,
       age: 100,
    },
    title    : Nintendo,
    fans     : [r432i900fds09809n, fdsjifdsjfueu88]
  }
}