Options
All
  • Public
  • Public/Protected
  • All
Menu

Options that are passed to any model creating a SELECT query

A hash of options to describe the scope of the search

Hierarchy

Index

Properties

Optional attributes

attributes: FindOptionsAttributesArray | object

A list of the attributes that you want to select. To rename an attribute, you can pass an array, with two elements - the first is the name of the attribute in the DB (or some kind of expression such as Sequelize.literal, Sequelize.fn and so on), and the second is the name you want the attribute to have in the returned instance

Optional benchmark

benchmark: boolean

Print query execution time in milliseconds when logging SQL.

Optional distinct

distinct: boolean

Apply DISTINCT(col) for FindAndCount(all)

Optional group

group: string | string[] | Object

Optional having

having: WhereOptions

having ?!?

Optional include

include: Array<Model<any, any> | IncludeOptions>

A list of associations to eagerly load using a left join. Supported is either { include: [ Model1, Model2, ...]} or { include: [{ model: Model1, as: 'Alias' }]}. If your association are set up with an as (eg. X.hasMany(Y, { as: 'Z }, you need to specify Z in the as attribute when eager loading Y).

Optional limit

limit: number

Limit the results

Optional lock

lock: string | object

Lock the selected rows. Possible options are transaction.LOCK.UPDATE and transaction.LOCK.SHARE. Postgres also supports transaction.LOCK.KEY_SHARE, transaction.LOCK.NO_KEY_UPDATE and specific model locks with joins. See transaction.LOCK for an example

Optional logging

logging: boolean | Function

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

Optional offset

offset: number

Skip the results;

Optional order

order: string | col | literal | Array<string | number | Model<any, any> | object> | Array<string | col | literal | Array<string | number | Model<any, any> | object>>

Specifies an ordering. If a string is provided, it will be escaped. Using an array, you can provide several columns / functions to order by. Each element can be further wrapped in a two-element array. The first element is the column / function to order by, the second is the direction. For example: order: [['name', 'DESC']]. In this way the column will be escaped, but the direction will not.

Optional paranoid

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 options.paranoid is true for the model.

Optional raw

raw: boolean

Return raw result. See sequelize.query for more information.

Optional searchPath

searchPath: string

An optional parameter to specify the schema search_path (Postgres only)

Optional transaction

transaction: Transaction

Transaction to run query under

Optional where

where: WhereOptions | Array<col | and | or | string>

A hash of attributes to describe your search. See above for examples.

Generated using TypeDoc