Interface HasManyRemoveAssociationsMixinOptions<T>

The options for the removeAssociations mixin of the hasMany association.

See

HasManyRemoveAssociationsMixin

interface HasManyRemoveAssociationsMixinOptions<T> {
    [COMPLETES_TRANSACTION]?: boolean;
    association?: boolean;
    benchmark?: boolean;
    connection?: null | AbstractConnection;
    destroy?: boolean | Omit<DestroyOptions<Attributes<T>>, "transaction" | "logging" | "benchmark" | "where">;
    fields?: (keyof Attributes<T>)[];
    hooks?: boolean;
    logging?: false | ((sql, timing?) => void);
    omitNull?: boolean;
    raw?: boolean;
    reset?: boolean;
    returning?: boolean | (Col | Literal | keyof Attributes<T>)[];
    searchPath?: string;
    silent?: boolean;
    transaction?: null | Transaction;
    validate?: boolean;
}

Type Parameters

Hierarchy (view full)

Properties

[COMPLETES_TRANSACTION]? association? benchmark? connection? destroy? fields? hooks? logging? omitNull? raw? reset? returning? searchPath? silent? transaction? validate?

Properties

Private Optional [COMPLETES_TRANSACTION]

[COMPLETES_TRANSACTION]?: boolean

Indicates if the query completes the transaction Internal only

Optional association

association?: boolean

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 destroy

destroy?: boolean | Omit<DestroyOptions<Attributes<T>>, "transaction" | "logging" | "benchmark" | "where">

Delete the associated model. Default to false.

Only applies if the foreign key is nullable. If the foreign key is not nullable, the associated model is always deleted.

Optional fields

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

An optional array of strings, representing database columns. If fields is provided, only those columns will be validated and saved.

Optional hooks

hooks?: boolean

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

Default

true

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 omitNull

omitNull?: boolean

A flag that defines if null values should be passed as values or not.

Default

false

Optional raw

raw?: boolean

If set to true, field and virtual setters will be ignored

Optional reset

reset?: boolean

Clear all previously set data values

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 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]associationbenchmarkconnectiondestroyfieldshooksloggingomitNullrawresetreturningsearchPathsilenttransactionvalidate