検索 (ブループリント)
指定された条件に一致するレコードのリストを検索し、(可能な場合は)それぞれに購読します。
GET /:model
結果は、ブループリントの設定と/またはリクエストで送信されたパラメータに基づいて、フィルタリング、ページング、ソートできます。
アクションがソケットリクエストによってトリガーされた場合、リクエスト元のソケットは返されたすべてのレコードに「購読」されます。返されたレコードのいずれかがその後更新または削除されると、その変更を知らせるメッセージがそのソケットのクライアントに送信されます。詳細については、Model.subscribe() のドキュメントを参照してください。
パラメータ
| パラメータ | 型 | 詳細 |
|---|---|---|
| model | 包含モデルのidentity。 例: 'purchase' (GET /purchase内) |
|
| _*_ | 特定の属性に基づいて結果をフィルタリングするには、モデルで定義されている属性と同じ名前のクエリパラメータを指定します。 たとえば、 Purchaseモデルにamount属性がある場合、GET /purchase?amount=99.99を送信して、99.99ドルの購入のリストを返すことができます。 |
|
| where | 特定の属性に基づいてフィルタリングする代わりに、Waterline クライテリアのWHERE句をJSON文字列としてエンコードしたwhereパラメータを提供することを選択できます。これにより、より強力なfind()クエリのために、contains、startsWith、およびその他のサブ属性クライテリア修飾子を利用できます。例: ?where={"name":{"contains":"theodore"}} |
|
| limit | 返すレコードの最大数(ページングに便利)。デフォルトは30。 例: ?limit=100 |
|
| skip | スキップするレコードの数(ページングに便利)。 例: ?skip=30 |
|
| sort | ソート順。デフォルトでは、返されたレコードは主キーの値で昇順にソートされます。 例: ?sort=lastName%20ASC |
|
| select | 結果の各レコードに含める属性を、コンマ区切りのリストとして指定します。デフォルトでは、すべての属性が選択されます。複数(「コレクション」)の関連付け属性には無効です。 例: ?select=name,age。 |
|
| omit | 結果の各レコードから除外する属性を、コンマ区切りのリストとして指定します。selectと併用することはできません。複数(「コレクション」)の関連付け属性には無効です。例: ?omit=favoriteColor,address。 |
|
| populate | 指定されている場合、デフォルトの自動ポピュレーションプロセスをオーバーライドします。レコード値をポピュレートする属性名をコンマ区切りのリストで受け入れるか、属性をポピュレートしないようにfalseを指定します。モデルで定義された関連付けに従って、返されたレコードのリストの属性をポピュレーションプロセスがどのように埋め込むかについての詳細は、こちらを参照してください。 |
例
データベースから最新の購入を最大30件検索する
GET /purchase?sort=createdAt DESC&limit=30
期待されるレスポンス
例:
[
{
"amount": 49.99,
"id": 1,
"createdAt": 1485551132315,
"updatedAt": 1485551132315
},
{
"amount": 99.99,
"id": 47,
"createdAt": 1485551158349,
"updatedAt": 1485551158349
}
]
jQueryの使用
詳細はjquery.comを参照してください。
$.get('/purchase?sort=createdAt DESC', function (purchases) {
console.log(purchases);
});
sails.io.jsの使用
詳細はsails.io.jsを参照してください。
io.socket.get('/purchase?sort=createdAt DESC', function (purchases) {
console.log(purchases);
});
Angularの使用
詳細はAngularを参照してください。
$http.get('/purchase?sort=createdAt DESC')
.then(function (res) {
var purchases = res.data;
console.log(purchases);
});
cURLの使用
cURLの詳細については、WikipediaのcURLに関するページをご覧ください。
curl https://#:1337/purchase?sort=createdAt%20DESC
備考
上記の例では、「rest」ブループリントが有効になっており、プロジェクトに
Purchaseモデルが含まれていることを前提としています。これは、以下を実行することで簡単に実現できます。$ 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>.
sailsjs.comをより快適にご利用いただくために、ブラウザを更新してください。
リファレンス
- アプリケーション
- ブループリントAPI
- コマンドラインインターフェース
-
設定
- 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
-
リクエスト (`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
- レスポンス (`res`)
- Waterline (ORM)
- WebSockets
リファレンス
愛情込めて作成
Sailsフレームワークは、貢献者たちの助けを借りて、テキサス州オースティンにあるウェブ＆モバイルショップによって開発されました。私たちは2012年にNode.jsプロジェクトを支援するためにSailsを作成し、当然のことながらオープンソース化しました。皆様の生活を少しでも楽にできれば幸いです！
© 2012-2024 The Sails Company.
Sailsフレームワークは、MITライセンスの下で無料でオープンソース化されています。
イラストはEdamameによるものです。