Interface BelongsToManyCreateAssociationMixinOptions<T>

The options for the createAssociation mixin of the belongsToMany association.

See

BelongsToManyCreateAssociationMixin

interface BelongsToManyCreateAssociationMixinOptions<T> {
    [COMPLETES_TRANSACTION]?: boolean;
    benchmark?: boolean;
    connection?: null | AbstractConnection;
    fields?: (keyof Attributes<T>)[];
    hooks?: boolean;
    ignoreDuplicates?: boolean;
    include?: AllowArray<Includeable>;
    isNewRecord?: boolean;
    logging?: false | ((sql, timing?) => void);
    raw?: boolean;
    returning?: boolean | (Col | Literal | keyof Attributes<T>)[];
    searchPath?: string;
    silent?: boolean;
    through?: JoinTableAttributes;
    transaction?: null | Transaction;
    validate?: boolean;
}

Type Parameters

Hierarchy (view full)

Properties

[COMPLETES_TRANSACTION]? benchmark? connection? fields? hooks? ignoreDuplicates? include? isNewRecord? logging? raw? returning? searchPath? silent? through? transaction? validate?

Properties

Private Optional [COMPLETES_TRANSACTION]

[COMPLETES_TRANSACTION]?: boolean

Indicates if the query completes the transaction Internal only

Optional benchmark

benchmark?: boolean

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

Optional connection

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.

Optional fields

fields?: (keyof Attributes<T>)[]

If set, only columns matching those in fields will be saved

Optional hooks

hooks?: boolean

If false the applicable hooks will not be called. The default value depends on the context.

Default

true

Optional ignoreDuplicates

ignoreDuplicates?: boolean

dialect specific ON CONFLICT DO NOTHING / INSERT IGNORE

Optional include

include?: AllowArray<Includeable>

An array of include options. A single option is also supported - Used to build prefetched/included model instances. See set

Optional isNewRecord

isNewRecord?: boolean

Is this record new

Optional logging

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

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

Type declaration

    • (sql, timing?): void

    • Parameters

      • sql: string
      • Optional timing: number

      Returns void

Optional raw

raw?: boolean

If set to true, values will ignore field and virtual setters.

Default

false

Optional returning

returning?: boolean | (Col | Literal | keyof Attributes<T>)[]

Return the affected rows (only for postgres)

Optional searchPath

searchPath?: string

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

Optional silent

silent?: boolean

If true, the updatedAt timestamp will not be updated.

Default

false

Optional through

through?: JoinTableAttributes

Optional transaction

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.

Optional validate

validate?: boolean

If false, validations won't be run.

Default

true

Settings

Member Visibility

Theme

On This Page

[COMPLETES_TRANSACTION]benchmarkconnectionfieldshooksignoreDuplicatesincludeisNewRecordloggingrawreturningsearchPathsilentthroughtransactionvalidate