.sum()
Get the aggregate sum of the specified attribute across all matching records.
var total = await Something.sum(numericAttrName, criteria);
Usage
#| Argument | Type | Details | |
|---|---|---|---|
| 1 | numericAttrName | The name of the numeric attribute to be summed. | |
| 2 | criteria | The Waterline criteria to use for matching records in the database. If no criteria is specified, the sum will be computed across all of this model's records. sum queries do not support pagination using skip and limit or projections using select. |
Result
#| Type | Description |
|---|---|
| The aggregate sum of the specified attribute across all matching records. |
Errors
#| Name | Type | When? |
|---|---|---|
| UsageError | Thrown if something invalid was passed in. | |
| AdapterError | Thrown if something went wrong in the database adapter. | |
| Error | Thrown if anything else unexpected happens. |
See Concepts > Models and ORM > Errors for examples of negotiating errors in Sails and Waterline.
Example
#Get the cumulative account balance of all bank accounts that have less than $32,000 or are flagged as "suspended".
var total = await BankAccount.sum('balance')
.where({
or: [
{ balance: { '<': 32000 } },
{ suspended: true }
]
});
Notes
#
- This method can be used with
await, promise chaining, or traditional Node callbacks.- Some databases, like MySQL, may return
nullfor this kind of query; however, it's best practice for Sails/Waterline adapter authors to return0for consistency and type safety in app-level code.
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`)
- 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-2025 The Sails Company.
The Sails framework is free and open-source under the MIT License.
Illustrations by Edamame.