.populate( foreignKey, [query] )

Purpose

This chainable method is used between .find()/.update() and .exec() in order to retrieve records associated with the model being queried. You must supply the Foreign Key specified in your model config.

Overview

Parameters

Description Accepted Data Types Required ?
1 Foreign Key string Yes
2 Query object No

Example Usage

  2. User.find({name:'Mike'}).exec(function(e,r){
  3.   console.log(r[0].toJSON())
  4. })
  6. /* 
  7. { name: 'Mike',
  8.   age: 16,
  9.   createdAt: Wed Feb 12 2014 18:06:50 GMT-0600 (CST),
  10.   updatedAt: Wed Feb 12 2014 18:06:50 GMT-0600 (CST),
  11.   id: 7 }
  12. */
  14. User.find({name:'Mike'}).populate('pets').exec(function(e,r){
  15.   console.log(r[0].toJSON())
  16. });
  18. /*
  19. { pets: 
  20.    [ { name: 'Pinkie Pie',
  21.        color: 'pink',
  22.        id: 7,
  23.        createdAt: Wed Feb 12 2014 18:06:50 GMT-0600 (CST),
  24.        updatedAt: Wed Feb 12 2014 18:06:50 GMT-0600 (CST) },
  25.      { name: 'Rainbow Dash',
  26.        color: 'blue',
  27.        id: 8,
  28.        createdAt: Wed Feb 12 2014 18:06:50 GMT-0600 (CST),
  29.        updatedAt: Wed Feb 12 2014 18:06:50 GMT-0600 (CST) },
  30.      { name: 'Applejack',
  31.        color: 'orange',
  32.        id: 9,
  33.        createdAt: Wed Feb 12 2014 18:06:50 GMT-0600 (CST),
  34.        updatedAt: Wed Feb 12 2014 18:06:50 GMT-0600 (CST) } ],
  35.   name: 'Mike',
  36.   age: 16,
  37.   createdAt: Wed Feb 12 2014 18:06:50 GMT-0600 (CST),
  38.   updatedAt: Wed Feb 12 2014 18:06:50 GMT-0600 (CST),
  39.   id: 7 }
  40. */
  42. User.find({name:'Mike'}).populate('pets',{color:'pink'}).exec(function(e,r){
  43.   console.log(r[0].toJSON())
  44. });
  46. /*
  47. { pets: 
  48.    [ { name: 'Pinkie Pie',
  49.        color: 'pink',
  50.        id: 7,
  51.        createdAt: Wed Feb 12 2014 18:06:50 GMT-0600 (CST),
  52.        updatedAt: Wed Feb 12 2014 18:06:50 GMT-0600 (CST) }],
  53.   name: 'Mike',
  54.   age: 16,
  55.   createdAt: Wed Feb 12 2014 18:06:50 GMT-0600 (CST),
  56.   updatedAt: Wed Feb 12 2014 18:06:50 GMT-0600 (CST),
  57.   id: 7 }
  58. */

Notes

Any string arguments passed must be the primary key of the record.