Interface deleteOptions

interface deleteOptions {
    benchmark?: boolean | sequelizeFunc<undefined> | sequelizeFunc<false> | sequelizeFunc<true>;
    byField?: string;
    cascade?: boolean | sequelizeFunc<undefined> | sequelizeFunc<false> | sequelizeFunc<true>;
    force?: boolean | sequelizeFunc<undefined> | sequelizeFunc<false> | sequelizeFunc<true>;
    hooks?: boolean | sequelizeFunc<undefined> | sequelizeFunc<false> | sequelizeFunc<true>;
    individualHooks?: boolean | sequelizeFunc<undefined> | sequelizeFunc<false> | sequelizeFunc<true>;
    limit?: number | sequelizeFunc<undefined> | sequelizeFunc<number>;
    logging?: boolean | sequelizeFunc<undefined> | sequelizeFunc<false> | sequelizeFunc<true> | ((sql, timing?) => void) | sequelizeFunc<((sql, timing?) => void)>;
    middleware?: expressFunc;
    restartIdentity?: boolean | sequelizeFunc<undefined> | sequelizeFunc<false> | sequelizeFunc<true>;
    truncate?: boolean | sequelizeFunc<undefined> | sequelizeFunc<false> | sequelizeFunc<true>;
}

Hierarchy (view full)

  • operationFieldCore
  • expressCrudProps<Omit<DestroyOptions<unknown>, "where" | "transaction">>
    • deleteOptions

Properties

benchmark? byField? cascade? force? hooks? individualHooks? limit? logging? middleware? restartIdentity? truncate?

Properties

Optional benchmark

benchmark?: boolean | sequelizeFunc<undefined> | sequelizeFunc<false> | sequelizeFunc<true>

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

Optional byField

byField?: string

Optional cascade

cascade?: boolean | sequelizeFunc<undefined> | sequelizeFunc<false> | sequelizeFunc<true>

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 | sequelizeFunc<undefined> | sequelizeFunc<false> | sequelizeFunc<true>

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

Optional hooks

hooks?: boolean | sequelizeFunc<undefined> | sequelizeFunc<false> | sequelizeFunc<true>

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

Optional individualHooks

individualHooks?: boolean | sequelizeFunc<undefined> | sequelizeFunc<false> | sequelizeFunc<true>

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

Optional limit

limit?: number | sequelizeFunc<undefined> | sequelizeFunc<number>

How many rows to delete

Optional logging

logging?: boolean | sequelizeFunc<undefined> | sequelizeFunc<false> | sequelizeFunc<true> | ((sql, timing?) => void) | sequelizeFunc<((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 middleware

middleware?: expressFunc

Optional restartIdentity

restartIdentity?: boolean | sequelizeFunc<undefined> | sequelizeFunc<false> | sequelizeFunc<true>

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

Optional truncate

truncate?: boolean | sequelizeFunc<undefined> | sequelizeFunc<false> | sequelizeFunc<true>

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

Settings

Member Visibility

Theme

On This Page

benchmarkbyFieldcascadeforcehooksindividualHookslimitloggingmiddlewarerestartIdentitytruncate