.stream( criteria )
Purpose
This method uses a node write stream to pipe model data as it is retrieved without first having to buffer all of the results to memory.
Overview
Parameters
| Description | Accepted Data Types | Required ? | |
|---|---|---|---|
| 1 | Find Criteria | {},[{}], string, int |
Yes |
| 2 | Custom Write/End Methods | {} |
No |
Returned
| Description | Possible Data Types | |
|---|---|---|
| 1 | Error | Error |
| 2 | Stream of Records | stream |
Example Usage
UsersController.js
module.exports = {
testStream: function(req, res){
if (req.param('startStream') && req.isSocket){
var getSocket = req.socket;
// Start the stream. Pipe it to sockets.
User.stream({name:'Walter'}).pipe(getSocket.emit);
} else {
res.view();
}
}
}
`
views/users/testSocket.ejs
<script type="text/javascript">
window.onload = function startListening(){
socket.on('gotUser',function(data){
console.log(data.name + ' number ' + data.id + ' has joined the party');
});
};
</script>
<div class="addButton" onClick="socket.get('/users/testStream/', {startStream:true})">Stream all the Users!</div>
Notes
This method is useful for piping data from VERY large models straight to res. You can also pipe it other places. See the node stream docs for more info. Only the mongo, mysql, and posgresql adapters support this method. This won't work with the disk adapter. Any string arguments passed must be the ID of the record.
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.connections
- sails.config.cors
- sails.config.csrf
- sails.config.globals
- sails.config.http
- sails.config.i18n
- sails.config.log
- sails.config.models
- sails.config.policies
- sails.config.routes
- sails.config.session
- sails.config.sockets
- sails.config.views
-
Request (`req`)
- req.accepted
- req.acceptedCharsets
- req.acceptedLanguages
- req.body
- req.cookies
- req.fresh
- req.headers
- req.host
- 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.acceptsCharset()
- req.acceptsLanguage()
- req.allParams()
- req.file()
- req.get()
- req.is()
- req.param()
- Response (`res`)
- Waterline (ORM)
- WebSockets
Built with Love
The Sails framework is maintained by a web & mobile studio 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-2018 The Sails Company.
The Sails framework is free and open-source under the MIT License.