Find (blueprint)
Find a list of records that match the specified criteria and (if possible) subscribe to each of them.
GET /:model
Results may be filtered, paginated, and sorted based on the blueprint configuration and/or parameters sent in the request.
If the action was triggered via a socket request, the requesting socket will be "subscribed" to all records returned. If any of the returned records are subsequently updated or deleted, a message will be sent to that socket's client informing them of the change. See the docs for Model.subscribe() for details.
Parameters
| Parameter | Type | Details |
|---|---|---|
| model | The identity of the containing model. e.g. 'purchase' (in GET /purchase) |
|
| _*_ | To filter results based on a particular attribute, specify a query parameter with the same name as the attribute defined on your model. For instance, if our Purchase model has an amount attribute, we could send GET /purchase?amount=99.99 to return a list of $99.99 purchases. |
|
| where | Instead of filtering based on a specific attribute, you may instead choose to provide a where parameter with the WHERE piece of a Waterline criteria, encoded as a JSON string. This allows you to take advantage of contains, startsWith, and other sub-attribute criteria modifiers for more powerful find() queries. e.g. ?where={"name":{"contains":"theodore"}} |
|
| limit | The maximum number of records to send back (useful for pagination). Defaults to 30. e.g. ?limit=100 |
|
| skip | The number of records to skip (useful for pagination). e.g. ?skip=30 |
|
| sort | The sort order. By default, returned records are sorted by primary key value in ascending order. e.g. ?sort=lastName%20ASC |
|
| select | The attributes to include each record in the result, specified as a comma-delimited list. By default, all attributes are selected. Not valid for plural (“collection”) association attributes. e.g. ?select=name,age. |
|
| omit | The attributes to exclude from each record in the result, specified as a comma-delimited list. Cannot be used in conjuction with select. Not valid for plural (“collection”) association attributes.e.g. ?omit=favoriteColor,address. |
|
| populate | If specified, overide the default automatic population process. Accepts a comma-separated list of attribute names for which to populate record values, or specify false to have no attributes populated. See here for more information on how the population process fills out attributes in the returned list of records according to the model's defined associations. |
Example
Find up to 30 of the newest purchases in our database:
GET /purchase?sort=createdAt DESC&limit=30
Expected response
e.g.
[
{
"amount": 49.99,
"id": 1,
"createdAt": 1485551132315,
"updatedAt": 1485551132315
},
{
"amount": 99.99,
"id": 47,
"createdAt": 1485551158349,
"updatedAt": 1485551158349
}
]
Using jQuery
See jquery.com for more documentation.
$.get('/purchase?sort=createdAt DESC', function (purchases) {
console.log(purchases);
});
Using sails.io.js
See sails.io.js for more documentation.
io.socket.get('/purchase?sort=createdAt DESC', function (purchases) {
console.log(purchases);
});
Using Angular
See Angular for more documentation.
$http.get('/purchase?sort=createdAt DESC')
.then(function (res) {
var purchases = res.data;
console.log(purchases);
});
Using cURL
You can read more about cURL on Wikipedia.
curl http://localhost:1337/purchase?sort=createdAt%20DESC
Notes
The example above assumes "rest" blueprints are enabled, and that your project contains a
Purchasemodel. You can quickly achieve this by running:$ sails new foo $ cd foo $ sails generate model purchase $ sails lift # You will see a prompt about database auto-migration settings. # Just choose 1 (alter) and press <ENTER>.
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
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-2021 The Sails Company.
The Sails framework is free and open-source under the MIT License.
Illustrations by Edamame.