.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 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.) |
Note: For performance reasons, as of Sails v1.0 / Waterline 0.13, the
valuesToSetobject passed into this model method will be mutated in-place in most situations (whereas in Sails/Waterline v0.12, this was not necessarily the case).
Result
| Type | Description |
|---|---|
The updated records are not provided as a result by default, in order to optimize for performance. To override the default setting, chain .fetch() and an array of the updated 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. 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, a user’s list of friends), achieving the same result as the
replaceCollectionmethod. To modify items in a collection individually, use theaddToCollectionor removeFromCollection methods.
For a better experience on sailsjs.com, update your browser.
Reference
- Application
- Blueprint API
- Command-line interface
-
Configuration
- sails.config.*
- sails.config.blueprints
- sails.config.bootstrap()
- sails.config.custom
- sails.config.datastores
- sails.config.globals
- sails.config.http
- sails.config.i18n
- sails.config.log
- sails.config.models
- sails.config.policies
- sails.config.routes
- sails.config.security
- sails.config.session
- sails.config.sockets
- sails.config.views
-
Request (`req`)
- req._startTime
- req.body
- req.cookies
- req.fresh
- req.headers
- req.hostname
- req.ip
- req.ips
- req.isSocket
- req.method
- req.options
- req.originalUrl
- req.params
- req.path
- req.protocol
- req.query
- req.secure
- req.signedCookies
- req.socket
- req.subdomains
- req.url
- req.wantsJSON
- req.xhr
- req.accepts()
- req.acceptsCharsets()
- req.acceptsLanguages()
- req.allParams()
- req.file()
- req.get()
- req.is()
- req.param()
- req.setLocale()
- req.setTimeout()
- req.host
- Response (`res`)
- Waterline (ORM)
- WebSockets
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!
© 2012-2024 The Sails Company.
The Sails framework is free and open-source under the MIT License.
Illustrations by Edamame.