Destroy (blueprint)
Delete the record specified by id from the database forever and notify subscribed sockets.
DELETE /:model/:id
This destroys the record that matches the id parameter and responds with a JSON dictionary representing the destroyed instance. If no model instance exists matching the specified id, a 404 is returned.
Additionally, a destroy event will be published to all sockets subscribed to the record room, and all sockets currently subscribed to the record will be unsubscribed from it.
Parameters
| Parameter | Type | Details |
|---|---|---|
| model | The identity of the containing model. e.g. 'purchase' (in /purchase/7) |
|
| id (required) |
The primary key value of the record to destroy, specified in the path. e.g. '7' (in /purchase/7) . |
Example
Delete Pinkie Pie:
DELETE /user/4
Expected response
{
"name": "Pinkie Pie",
"hobby": "kickin",
"id": 4,
"createdAt": 1485550644076,
"updatedAt": 1485550644076
}
Socket notifications
If you have WebSockets enabled for your app, then every client subscribed to the destroyed record will receive a notification where the event name is that of the model identity (e.g. user), and the “message” has the following format:
verb: 'destroyed',
id: <the record primary key>,
previous: <a dictionary of the attribute values of the destroyed record (including populated associations)>
For instance, continuing the example above, all clients subscribed to User #4 (except for the client making the request) might receive the following message:
id: 4,
verb: 'destroyed',
previous: {
name: 'Pinkie Pie',
hobby: 'kickin',
createdAt: 1485550644076,
updatedAt: 1485550644076
}
If the destroyed record had any links to other records, there might be some additional notifications:
Assuming the record being destroyed in our example had an association with a via, then either updated or removedFrom notifications would also be sent to any clients who are subscribed to those child records on the other side of the relationship. See Blueprints > remove from and Blueprints > update for more info about the structure of those notifications.
If the association pointed at by the
viais plural (e.g.cashiers), then theremovedFromnotification will be sent. Otherwise, if theviapoints at a singular association (e.g.cashier) then theupdatednotification will be sent.
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.