Edit Page

.destroy()

Destroy records in your database that match the given criteria.

await Something.destroy(criteria);

Or:

var destroyedRecords = await Something.destroy(criteria).fetch();

Usage

	Argument	Type	Details
1	criteria		Records which match this Waterline criteria will be destroyed. Be warned, if you specify an empty dictionary (`{}`) as your criteria, all records will be destroyed! `destroy` queries do not support pagination using `skip` and `limit` or projections using `select`.

Result

Type	Description
of	For improved performance, the destroyed records are not provided as a result by default. But if you chain `.fetch()`, then the destroyed records will be sent back. (Be aware that this requires an extra database query in some adapters.)

Errors

Name	Type	When?
UsageError		Thrown if something invalid was passed in.
AdapterError		Thrown if something went wrong in the database adapter.
Error		Thrown if anything else unexpected happens.

See Concepts > Models and ORM > Errors for examples of negotiating errors in Sails and Waterline.

Meta keys

Key	Type	Details
fetch		If set to `true`, then the array of destroyed records will be sent back. Defaults to `false`.

For more information on meta keys, see .meta().

Example

To delete any users named Finn from the database:

await User.destroy({name:'Finn'});

sails.log('Any users named Finn have now been deleted, if there were any.');

To delete two particular users who have been causing trouble:

await User.destroy({
  id: { in: [ 3, 97 ] }
});

sails.log('The records for troublesome users (3 and 97) have been deleted, if they still existed.');

Fetching destroyed records

To delete a particular book, and also fetch the destroyed record, use .destroyOne().

Or to delete multiple books and also fetch all destroyed records:

var burnedBooks = await Book.destroy({
  controversiality: { '>': 0.9 }
}).fetch();
sails.log('Deleted books:', burnedBooks);

Notes

This method can be used with await, promise chaining, or traditional Node callbacks.

If you want to confirm that one or more records exist before destroying them, you should first perform a find(). However, keep in mind it is generally a good idea to try to do things rather than checking first, lest you end up with a race condition.

Is something missing?

If you notice something we've missed or could be improved on, please follow this link and submit a pull request to the sails-docs repo. Once we merge it, the changes will be reflected on the website the next time it is deployed.

Documentation

Reference

Built with Love

The Sails framework is built by a web & mobile shop in Austin, TX, with the help of our contributors. We created Sails in 2012 to assist us on Node.js projects. Naturally we open-sourced it. We hope it makes your life a little bit easier!