Edit Page

.update()

Update all records matching criteria.

await Something.update(criteria)
.set(valuesToSet);

Or:

var updatedRecords = await Something.update(criteria).set(valuesToSet).fetch();

Usage

	Argument	Type	Details
1	criteria		The Waterline criteria to use for matching records in the database. `update` queries do not support pagination using `skip` and `limit` or projections using `select`.
2	valuesToSet		A dictionary (plain JavaScript object) of values to that all matching records should be updated to have. (Note that, if this model is in "schemaful" mode, then any extraneous keys will be silently omitted.)

Result

Type	Description
	By default, for better performance, the updated records are not provided as a result. But if you chain `.fetch()`, then the array of updated record(s) will be sent back. (Be aware that this requires extra database queries 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. See Concepts > Models and ORM > Errors for an example of how to negotiate a uniqueness error (i.e. from attempting to update one or more records so that they violate a uniqueness constraint).
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 updated records will be sent back. Defaults to `false`.

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

Example

To update a particular record, use .updateOne().

Or to update one or more records at the same time:

await User.update({ name:'Pen' })
.set({
  name:'Finn'
});

sails.log('Updated all users named Pen so that their new name is "Finn".  I hope they like it.');

Fetching updated records

To fetch updated records, use enable the fetch meta key:

var updatedUsers = await User.update({name:'Finn'})
.set({
  name:'Jake'
})
.fetch();

sails.log(`Updated all ${updatedUsers.length} user${updatedUsers.length===1?'':'s'} named "Finn" to have the name "Jake".  Here they are now:`);
sails.log(updatedUsers);

Notes

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

This method can be used to replace an entire collection association (for example, to replace a user’s list of friends), achieving the same result as the replaceCollection method. To modify items in a collection individually, use the addToCollection or removeFromCollection methods.

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!