Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface DestroyOptions<TAttributes>

Options used for Model.destroy

Type parameters

  • TAttributes = any

Hierarchy

Index

Properties

benchmark?: boolean

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

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;

force?: boolean

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

default

false

hooks?: boolean

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

default

true

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

limit?: Nullish<number | Literal>

How many rows to delete

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

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

restartIdentity?: boolean

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

default

false

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.

truncate?: boolean

If set to true, dialects that support it will use TRUNCATE instead of DELETE FROM. If a table is truncated the where and limit options are ignored.

Danger: This will completely empty your table!

where?: WhereOptions<TAttributes>

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

Generated using TypeDoc