*.remove( primary key )

Purpose

Used to remove records from the join table that is automatically generated during a many-to-many association. Unlike .add(), it only accepts the primary key of the model instance (defaults to record ID).

Overview

Parameters

Description Accepted Data Types Required ?
1 Primary Key string, int Yes

Example Usage

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

Notes

  • Any string arguments passed must be the primary key of the record.
  • .remove() alone won’t actually persist the change in associations to the databse. You should call .save() after using .add() or .remove().