Interface InstanceUpdateOptions<TAttributes>

Options used for Instance.update method

interface InstanceUpdateOptions<TAttributes = any> {
    association?: boolean;
    benchmark?: boolean;
    connection?: null | AbstractConnection;
    fields?: (keyof TAttributes)[];
    hooks?: boolean;
    logging?: false | (sql: string, timing?: number) => void;
    omitNull?: boolean;
    raw?: boolean;
    reset?: boolean;
    returning?: boolean | (Col | Literal | keyof TAttributes)[];
    searchPath?: string;
    silent?: boolean;
    transaction?: null | Transaction;
    validate?: boolean;
    where?: WhereOptions<TAttributes>;
}

Type Parameters

  • TAttributes = any

Hierarchy (View Summary)

Properties

association? benchmark? connection? fields? hooks? logging? omitNull? raw? reset? returning? searchPath? silent? transaction? validate? where?

Properties

Optionalassociation

association?: boolean

Optionalbenchmark

benchmark?: boolean

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

Optionalconnection

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.

Optionalfields

fields?: (keyof TAttributes)[]

An optional array of strings, representing database columns. If fields is provided, only those columns will be validated and saved.

Optionalhooks

hooks?: boolean

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

Default

true

Optionallogging

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

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

OptionalomitNull

omitNull?: boolean

A flag that defines if null values should be passed as values or not.

Default

false

Optionalraw

raw?: boolean

If set to true, field and virtual setters will be ignored

Optionalreset

reset?: boolean

Clear all previously set data values

Optionalreturning

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

Return the affected rows (only for postgres)

OptionalsearchPath

searchPath?: string

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

Optionalsilent

silent?: boolean

If true, the updatedAt timestamp will not be updated.

Default

false

Optionaltransaction

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.

Optionalvalidate

validate?: boolean

If false, validations won't be run.

Default

true

Optionalwhere

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