Interface InstanceUpdateOptions<TAttributes>

Options used for Instance.update method

Type Parameters

  • TAttributes = any

Hierarchy

Properties

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

Properties

Optional association

association?: boolean

Optional benchmark

benchmark?: boolean

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

Optional fields

fields?: (keyof TAttributes)[]

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

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?: boolean | ((sql: string, timing?: number) => void)

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

Optional omitNull

omitNull?: boolean

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

Default

false

Optional raw

raw?: boolean

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

Optional reset

reset?: boolean

Clear all previously set data values

Optional returning

returning?: boolean | (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.

If CLS is enabled and a transaction is running in the current CLS context, that transaction will be used, unless null or a Transaction is manually specified here.

Optional validate

validate?: boolean

If false, validations won't be run.

Default

true

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

Generated using TypeDoc