Interface IncludeThroughOptions

Through options for Include Options

interface IncludeThroughOptions {
    as?: string;
    attributes?: FindAttributeOptions<any>;
    paranoid?: boolean;
    where?: WhereOptions<any>;
}

Hierarchy (View Summary)

Properties

as? attributes? paranoid? where?

Properties

Optionalas

as?: string

The alias for the join model, in case you want to give it a different name than the default one.

Optionalattributes

attributes?: FindAttributeOptions<any>

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

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

  • The first is the name of the attribute (or literal, fn, col, cast),
  • 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'] } }

Optionalparanoid

paranoid?: boolean

If true, only non-deleted records will be returned from the join table. If false, both deleted and non-deleted records will be returned. Only applies if through model is paranoid.

Default

true

Optionalwhere

where?: WhereOptions<any>

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