Interface AggregateOptions<T, TAttributes>

Options used for Model.aggregate

interface AggregateOptions<T extends DataType | unknown, TAttributes = any> {
    benchmark?: boolean;
    bind?: BindOrReplacements;
    connection?: null | AbstractConnection;
    dataType?: string | T;
    distinct?: boolean;
    fieldMap?: FieldMap;
    instance?: Model<any, any>;
    logging?: false | (sql: string, timing?: number) => void;
    mapToModel?: boolean;
    nest?: boolean;
    paranoid?: boolean;
    plain?: boolean;
    raw?: boolean;
    replacements?: BindOrReplacements;
    retry?: Options;
    supportsSearchPath?: boolean;
    transaction?: null | Transaction;
    type?: string;
    useMaster?: boolean;
    where?: WhereOptions<TAttributes>;
}

Type Parameters

  • T extends DataType | unknown
  • TAttributes = any

Hierarchy (View Summary)

Properties

benchmark? bind? connection? dataType? distinct? fieldMap? instance? logging? mapToModel? nest? paranoid? plain? raw? replacements? retry? supportsSearchPath? transaction? type? useMaster? where?

Properties

Optionalbenchmark

benchmark?: boolean

Pass query execution time in milliseconds as second argument to logging function (options.logging).

Optionalbind

bind?: BindOrReplacements

Either 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.

Optionalconnection

connection?: null | AbstractConnection

The connection on which this query must be run. Mutually exclusive with Transactionable.transaction.

Can be used to ensure that a query is run on the same connection as a previous query, which is useful when configuring session options.

Specifying this option takes precedence over CLS Transactions. If a transaction is running in the current AsyncLocalStorage context, it will be ignored in favor of the specified connection.

OptionaldataType

dataType?: string | T

The 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.

Optionaldistinct

distinct?: boolean

Applies DISTINCT to the field being aggregated over

OptionalfieldMap

fieldMap?: FieldMap

Map returned fields to arbitrary names for SELECT query type if options.fieldMaps is present.

Optionalinstance

instance?: Model<any, any>

A sequelize instance used to build the return instance

Optionallogging

logging?: false | (sql: string, timing?: number) => void

A function that gets executed while running the query to log the sql.

OptionalmapToModel

mapToModel?: boolean

Map returned fields to model's fields if options.model or options.instance is present. Mapping will occur before building the model instance.

Optionalnest

nest?: boolean

If 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

Default

false

Optionalparanoid

paranoid?: boolean

If true, only non-deleted records will be returned. If false, both deleted and non-deleted records will be returned.

Only applies if InitOptions.paranoid is true for the model.

Default

true

Optionalplain

plain?: boolean

Sets the query type to SELECT and return a single row

Optionalraw

raw?: boolean

If true, sequelize will not try to format the results of the query, or build an instance of a model from the result

Optionalreplacements

replacements?: BindOrReplacements

Either an object of named parameter replacements in the format :param or an array of unnamed replacements to replace ? in your SQL.

Optionalretry

retry?: Options

OptionalsupportsSearchPath

supportsSearchPath?: boolean

If false do not prepend the query with the search_path (Postgres only)

Optionaltransaction

transaction?: null | Transaction

The transaction in which this query must be run. Mutually exclusive with Transactionable.connection.

If the Sequelize disableClsTransactions option has not been set to true, and a transaction is running in the current AsyncLocalStorage context, that transaction will be used, unless null or another Transaction is manually specified here.

Optionaltype

type?: string

The 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.

OptionaluseMaster

useMaster?: boolean

Force the query to use the write pool, regardless of the query type.

Default

false

Optionalwhere

where?: WhereOptions<TAttributes>

The 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.

Settings

Member Visibility

On This Page

Properties