Documentation
    Preparing search index...

    Interface TruncateOptions

    The options accepted by Model.truncate.

    interface TruncateOptions {
        benchmark?: boolean;
        cascade?: boolean;
        connection?: AbstractConnection | null;
        hooks?: boolean;
        logging?: false | ((sql: string, timing?: number) => void);
        restartIdentity?: boolean;
        transaction?: Transaction | null;
    }

    Hierarchy (View Summary)

    Index
    benchmark? cascade? connection? hooks? logging? restartIdentity? transaction?
    benchmark?: boolean

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

    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.

    false
    connection?: AbstractConnection | null

    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.

    hooks?: boolean

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

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

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

    restartIdentity?: boolean

    Automatically restart sequences owned by columns of the truncated table

    false
    transaction?: Transaction | null

    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.

    Settings
    Member Visibility

    On This Page
    Properties