Interface TruncateOptions<TAttributes>

The options passed to Model.destroy in addition to truncate

Type Parameters

  • TAttributes = any

Hierarchy

Properties

benchmark? cascade? force? hooks? individualHooks? limit? logging? restartIdentity? transaction? where?

Properties

Optional benchmark

benchmark?: boolean

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

Optional cascade

cascade?: boolean

Only used in conjuction with TRUNCATE. Truncates all tables that have foreign-key references to the named table, or to any tables added to the group due to CASCADE.

Default

false;

Optional force

force?: boolean

Delete instead of setting deletedAt to current timestamp (only applicable if paranoid is enabled)

Default

false

Optional hooks

hooks?: boolean

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

Default

true

Optional individualHooks

individualHooks?: boolean

If set to true, destroy will SELECT all records matching the where parameter and will execute before / after destroy hooks on each row

Default

false

Optional limit

limit?: Nullish<number | Literal>

How many rows to delete

Optional logging

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

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

Optional restartIdentity

restartIdentity?: boolean

Only used in conjunction with truncate. Automatically restart sequences owned by columns of the truncated table

Default

false

Optional transaction

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.

Optional where

where?: WhereOptions<TAttributes>

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

Theme

Generated using TypeDoc