Optional benchmarkPass query execution time in milliseconds as second argument to logging function (options.logging).
Optional bindEither an object of named parameter bindings in the format $param or an array of unnamed
values to bind to $1, $2, etc in your SQL.
Optional dataThe type of the result. If attribute being aggregated is a defined in the Model,
the default will be the type of that attribute, otherwise defaults to a plain JavaScript number.
Optional distinctApplies DISTINCT to the field being aggregated over
Optional fieldMap returned fields to arbitrary names for SELECT query type if options.fieldMaps is present.
Optional instanceA sequelize instance used to build the return instance
Optional loggingA function that gets executed while running the query to log the sql.
Optional mapMap returned fields to model's fields if options.model or options.instance is present.
Mapping will occur before building the model instance.
Optional nestIf true, transforms objects with . separated property names into nested objects using
dottie.js. For example { 'user.username': 'john' } becomes
{ user: { username: 'john' }}. When nest is true, the query type is assumed to be 'SELECT',
unless otherwise specified
false
Optional paranoidIf true, only non-deleted records will be returned. If false, both deleted and non-deleted records will be returned.
Only applies if paranoid is true for the model.
true
Optional plainSets the query type to SELECT and return a single row
Optional rawIf true, sequelize will not try to format the results of the query, or build an instance of a model from the result
Optional replacementsEither an object of named parameter replacements in the format :param or an array of unnamed
replacements to replace ? in your SQL.
Optional retryOptional transactionThe transaction in which this query must be run.
If CLS is enabled and a transaction is running in the current CLS context, that transaction will be used, unless null or a Transaction is manually specified here.
Optional typeThe type of query you are executing. The query type affects how results are formatted before they are
passed back. The type is a string, but Sequelize.QueryTypes is provided as convenience shortcuts.
Optional useForce the query to use the write pool, regardless of the query type.
false
Optional whereThe WHERE clause. Can be many things from a hash of attributes to raw SQL.
Visit https://sequelize.org/docs/v7/core-concepts/model-querying-basics/ for more information.
Generated using TypeDoc
Options used for Model.aggregate