* .add( primary key )

Purpose

Used to add records to the join table that is automatically generated during a Many-to-Many association. It accepts either the primary key of the model instance (defaults to record ID) or a new record (object) that you want created and to be associated with.

Overview

Parameters

Description Accepted Data Types Required ?
1 Records {}, string, int Yes

Example Usage

  1. User.find({name:'Mike'}).populate('pets').exec(function(e,r){
  2.   r[0].pets.add(7);
  3.   r[0].save(function(err,res){
  4.     console.log(res);
  5.   }
  6. });
  8. /*
  10. { pets:
  11.    [ { name: 'Pinkie Pie',
  12.        color: 'pink',
  13.        id: 7,
  14.        createdAt: Wed Feb 12 2014 18:06:50 GMT-0600 (CST),
  15.        updatedAt: Wed Feb 12 2014 18:06:50 GMT-0600 (CST) },
  16.      { name: 'Rainbow Dash',
  17.        color: 'blue',
  18.        id: 8,
  19.        createdAt: Wed Feb 12 2014 18:06:50 GMT-0600 (CST),
  20.        updatedAt: Wed Feb 12 2014 18:06:50 GMT-0600 (CST) },
  21.      { name: 'Applejack',
  22.        color: 'orange',
  23.        id: 9,
  24.        createdAt: Wed Feb 12 2014 18:06:50 GMT-0600 (CST),
  25.        updatedAt: Wed Feb 12 2014 18:06:50 GMT-0600 (CST) } ],
  26.   name: 'Mike',
  27.   age: 16,
  28.   createdAt: Wed Feb 12 2014 18:06:50 GMT-0600 (CST),
  29.   updatedAt: Wed Feb 12 2014 19:30:54 GMT-0600 (CST),
  30.   id: 7 }
  32. */

Notes

  • .add() does not accept arrays of any kind. Don’t try it.
  • Any string arguments passed must be the primary key of the record.
  • .add() alone won’t actually persist the change in associations to the databse. You should call .save() after using .add() or .remove().