.archive()
Archive ("soft-delete") records that match the specified criteria, saving them as new records in the built-in Archive model, then destroying the originals.
await Something.archive(criteria);
Usage
| Argument | Type | Details | |
|---|---|---|---|
| 1 | criteria | Records that match this Waterline criteria will be archived. Be warned, if you specify an empty dictionary ({}) as your criteria, all records will be destroyed! |
Callback
| Argument | Type | Details | |
|---|---|---|---|
| 1 | err | The error that occurred, or null if there were no errors. |
|
| 2 | archivedRecords | For improved performance, the archived records are not provided to this callback by default. But if you chain .fetch(), then the recently archived records will be sent back. (Be aware that this requires an extra database query in some adapters.) |
Example
To archive a particular user in the the database, use .archiveOne().
Or to archive multiple records in the the database:
await Pet.archive({ lastActiveAt: { '<': Date.now()-1000*60*60*24*365 } });
Accessing archived records
If you need to access archived records in the future, you can do so by searching the Archive model. For example, you might pass in the original record's primary key and model identity as constraints in a query.
For example, to retrieve the archive describing the user we got rid of above:
var archive = await Archive.findOne({
fromModel: 'user',
originalRecordId: 1
});
// The data from the original record is stored as `archive.originalRecord`.
Notes
This method is best used in situations where you would otherwise use
.destroy(), but you still need to keep the deleted data somewhere (e.g. for compliance reasons). If you anticipate needing to access the data again in your app (e.g. if you allow un-deleting), you may want to consider using anisDeletedflag instead, since archived records are more difficult to work with programmatically. (There is no built-in "unarchive".)
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-2025 The Sails Company.
The Sails framework is free and open-source under the MIT License.
Illustrations by Edamame.