Interface IncrementDecrementOptionsWithBy<TAttributes>

Options used for Instance.increment method

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

Type Parameters

  • TAttributes = any

Hierarchy (view full)

Properties

[COMPLETES_TRANSACTION]? benchmark? by? connection? logging? returning? searchPath? silent? transaction? where?

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 by

by?: number

The number to increment by

Default

1

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

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

Return the affected rows (only for postgres)

Optional searchPath

searchPath?: string

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

Optional silent

silent?: boolean

If true, the updatedAt timestamp will not be updated.

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 where

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

Theme

On This Page

[COMPLETES_TRANSACTION]benchmarkbyconnectionloggingreturningsearchPathsilenttransactionwhere