Interface SequelizeTruncateOptions

The options accepted by Model.truncate.

interface SequelizeTruncateOptions {
    [COMPLETES_TRANSACTION]?: boolean;
    benchmark?: boolean;
    cascade?: boolean;
    connection?: null | AbstractConnection;
    hooks?: boolean;
    logging?: false | ((sql, timing?) => void);
    restartIdentity?: boolean;
    transaction?: null | Transaction;
    withoutForeignKeyChecks?: boolean;
}

Hierarchy (view full)

Properties

[COMPLETES_TRANSACTION]? benchmark? cascade? connection? hooks? logging? restartIdentity? transaction? withoutForeignKeyChecks?

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 cascade

cascade?: boolean

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 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 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 restartIdentity

restartIdentity?: boolean

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. 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 withoutForeignKeyChecks

withoutForeignKeyChecks?: boolean

Most dialects will not allow you to truncate a table while other tables have foreign key references to it (even if they are empty). This option will disable those checks while truncating all tables, and re-enable them afterwards.

This option is currently only supported for MySQL, SQLite, and MariaDB.

Postgres can use TruncateOptions.cascade to achieve a similar goal.

If you're experiencing this problem in other dialects, consider using Sequelize.destroyAll instead.

Settings

Member Visibility

Theme

On This Page

[COMPLETES_TRANSACTION]benchmarkcascadeconnectionhooksloggingrestartIdentitytransactionwithoutForeignKeyChecks