Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface BelongsToManyGetAssociationsMixinOptions

The options for the getAssociations mixin of the belongsToMany association.

see

BelongsToManyGetAssociationsMixin

Hierarchy

Index

Properties

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'] } }
benchmark?: boolean

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

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.

fieldMap?: FieldMap

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

group?: GroupOption

GROUP BY in sql

groupedLimit?: unknown
having?: WhereOptions<any>

Select group rows after groups and aggregates are computed.

A list of associations to eagerly load using a left join (a single association is also supported).

See Includeable to see how to specify the association, and its eager-loading options.

indexHints?: IndexHint[]

MySQL only.

instance?: Model<any, any>

A sequelize instance used to build the return instance

joinTableAttributes?: FindAttributeOptions

A list of the attributes from the join table that you want to select.

limit?: Nullish<number | Literal>

Limits how many items will be retrieved by the operation.

If limit and include are used together, Sequelize will turn the subQuery option on by default. This is done to ensure that limit only impacts the Model on the same level as the limit option.

You can disable this behavior by explicitly setting subQuery: false, however limit will then affect the total count of returned values, including eager-loaded associations, instead of just one table.

example
// in the following query, `limit` only affects the "User" model.
// This will return 2 users, each including all of their projects.
User.findAll({
limit: 2,
include: [User.associations.projects],
});
example
// in the following query, `limit` affects the total number of returned values, eager-loaded associations included.
// This may return 2 users, each with one project,
// or 1 user with 2 projects.
User.findAll({
limit: 2,
include: [User.associations.projects],
subQuery: false,
});
lock?: boolean | LOCK | { level: LOCK; of: ModelStatic<Model<any, any>> }

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

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

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

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.

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

offset?: number | Literal

Skip the first n items of the results.

order?: Order

Specifies an ordering. If a string is provided, it will be escaped.

Using an array, you can provide several attributes / 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.
example

order: [['name', 'DESC']].

The attribute will be escaped, but the direction will not.

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

plain?: boolean

Sets the query type to SELECT and return a single row

raw?: boolean

Return raw result. See {@link Sequelize#query} for more information.

rejectOnEmpty?: boolean | Error

Throws an error if the query would return 0 results.

replacements?: BindOrReplacements

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

retry?: RetryOptions
scope?: string | boolean

Apply a scope on the related model, or remove its default scope by passing false.

searchPath?: string

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

skipLocked?: boolean

Skip locked rows. Only supported in Postgres.

subQuery?: boolean

Use sub queries (internal).

If unspecified, this will true by default if limit is specified, and false otherwise. See {@link FindOptions#limit} for more information.

transaction?: null | Transaction

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

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.

useMaster?: boolean

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

default

false

where?: WhereOptions<any>

The WHERE clause. Can be many things from a hash of attributes to raw SQL.

Generated using TypeDoc