Documentation
    Preparing search index...

    Interface IncrementDecrementOptionsWithBy<TAttributes>

    Options used for Instance.increment method

    interface IncrementDecrementOptionsWithBy<TAttributes = any> {
        benchmark?: boolean;
        by?: number;
        connection?: AbstractConnection | null;
        logging?: false | ((sql: string, timing?: number) => void);
        returning?: boolean | (Col | Literal | keyof TAttributes)[];
        searchPath?: string;
        silent?: boolean;
        transaction?: Transaction | null;
        where?: WhereOptions<TAttributes>;
    }

    Type Parameters

    • TAttributes = any

    Hierarchy (View Summary)

    Index
    benchmark? by? connection? logging? returning? searchPath? silent? transaction? where?
    benchmark?: boolean

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

    by?: number

    The number to increment by

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

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

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

    returning?: boolean | (Col | Literal | keyof TAttributes)[]

    Return the affected rows (only for postgres)

    searchPath?: string

    An optional parameter to specify the schema search_path (Postgres only)

    silent?: boolean

    If true, the updatedAt timestamp will not be updated.

    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.

    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

    On This Page
    Properties