IncludeOptions | @sequelize/core

Complex include options

Hierarchy

Filterable<any>
Projectable
Paranoid
- IncludeOptions

Index

Properties

Optional as

as?: string

The alias of the association. Used along with IncludeOptions.model.

This must be specified if the association has an alias (i.e. "as" was used when defining the association). For hasOne / belongsTo, this should be the singular name, and for hasMany / belongsToMany, it should be the plural.

Optional association

association?: string | Association<Model<any, any>, Model<any, any>>

The association you want to eagerly load. Either one of the values available in Model.associations, or the name of the association.

This can be used instead of providing a model/as pair.

This is the recommended method.

Optional attributes

attributes?: FindAttributeOptions

If an array: a list of the attributes that you want to select. Attributes can also be raw SQL (literal), fn, and col

To rename an attribute, you can pass an array, with two elements:

The first is the name of the attribute (or literal, fn, col),
and the second is the name to give to that attribute in the returned instance.

If include is used: selects all the attributes of the model, plus some additional ones. Useful for aggregations.

example

{ attributes: { include: [[literal('COUNT(id)'), 'total']] }

If exclude is used: selects all the attributes of the model, except the one specified in exclude. Useful for security purposes

example

{ attributes: { exclude: ['password'] } }

Optional duplicating

duplicating?: boolean

Mark the include as duplicating, will prevent a subquery from being used.

Optional include

include?: AllowArray<Includeable>

Load further nested related models

Optional limit

limit?: Nullish<number | Literal>

Limit include.

Only available when setting IncludeOptions.separate to true.

Optional model

model?: ModelStatic<Model<any, any>>

The model you want to eagerly load.

We recommend specifying IncludeOptions.association instead.

Optional on

on?: WhereOptions<any>

Custom ON clause, overrides default.

Optional or

or?: boolean

Whether to bind the ON and WHERE clause together by OR instead of AND.

default: false

Optional order

order?: Order

Order include. Only available when setting separate to true.

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

default: true

Optional required

required?: boolean

If true, converts to an inner join, which means that the parent model will only be loaded if it has any matching children.

True if include.where is set, false otherwise.

Optional right

right?: boolean

If true, converts to a right join if dialect support it.

Incompatible with IncludeOptions.required.

Optional separate

separate?: boolean

If true, runs a separate query to fetch the associated instances.

default: false

Optional subQuery

subQuery?: boolean

Use sub queries. This should only be used if you know for sure the query does not result in a cartesian product.

Optional through

through?: IncludeThroughOptions

Through Options

Optional where

where?: WhereOptions<any>

Where clauses to apply to the child model

Note that this converts the eager load to an inner join, unless you explicitly set IncludeOptions.required to false