.query()
As of Sails v1.0, this method is deprecated. Instead, please use
Model.getDatastore().sendNativeQuery(), the new version of this method that standardizes the format of SQL escape bindings, as well as fully supporting.exec()and promise-based usage.
Execute a raw SQL query using the specified model's datastore.
SomeModel.query(sql, valuesToEscape, function(err, rawResult) {
});
WARNING: Unlike other Waterine model methods,
.query()supports neither promise-based usage nor the use of.exec(). In other words, it does not utilize Waterline's normal deferred object mechanism. Instead, it provides raw access directly to the underlying database driver.
Usage
.query() is only available on Sails/Waterline models that are configured to use a SQL database (e.g. PostgreSQL or MySQL). Its purpose is to perform raw SQL queries. Note that exact usage and result format varies between adapters, so you'll need to refer to the documentation for the underlying database driver. (See below for a couple of simple examples to help get you started.)
| Argument | Type | Details | |
|---|---|---|---|
| 1 | sql | A SQL string written in the appropriate dialect for this model's database. Allows template syntax, (e.g. ?, $1) the exact style of which depends on the underlying database adapter. (See examples below.) |
|
| 2 | valuesToEscape | An array of dynamic, untrusted strings to SQL-escape and inject within the SQL string using the appropriate template syntax for this model's database. (If you have no dynamic values to inject, then just use an empty array here.) | |
| 3 | done | A callback function that will be triggered when the query completes successfully, or if the adapter encounters an error. |
Callback
| Argument | Type | Details | |
|---|---|---|---|
| 1 | err | The error that occurred, or a falsy value if there were no errors. (The exact format of this error varies depending on the SQL query you passed in and the database adapter you're using. See examples below for links to relevant documentation.) | |
| 2 | rawResult | The raw result from the adapter. (The exact format of this raw result data varies depending on the SQL query you passed in and the database adapter you're using. See examples below for links to relevant documentation.) |
Example
Remember that usage and result data vary depending on the SQL query you send and the adapter you're using. Below, you'll find two examples: one for PostgreSQL and one for MySQL.
PostgreSQL example
Communicate directly with pg, an NPM package used for communicating with PostgreSQL databases:
Pet.query('SELECT pet.name FROM pet WHERE pet.name = $1', [ 'dog' ] ,function(err, rawResult) {
if (err) { return res.serverError(err); }
sails.log(rawResult);
// (result format depends on the SQL query that was passed in, and the adapter you're using)
// Then parse the raw result and do whatever you like with it.
return res.ok();
});
MySQL example
Assuming the Pet model is configured to use the sails-mysql adapter, the following code will communicate directly with mysql, an NPM package used for communicating with MySQL databases:
Pet.query('SELECT pet.name FROM pet WHERE pet.name = ?', [ 'dog' ] ,function(err, rawResult) {
if (err) { return res.serverError(err); }
sails.log(rawResult);
// ...grab appropriate data...
// (result format depends on the SQL query that was passed in, and the adapter you're using)
// Then parse the raw result and do whatever you like with it.
return res.ok();
});
Notes
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.