Interface UpdateOptions<TAttributes>

Options used for Model.update

Type Parameters

  • TAttributes = any

Hierarchy

Properties

benchmark? connection? fields? hooks? individualHooks? limit? logging? paranoid? returning? sideEffects? silent? transaction? validate? where

Properties

Optional benchmark

benchmark?: boolean

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

Optional connection

connection?: null | Connection

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 fields

fields?: (keyof TAttributes)[]

Fields to update (defaults to all fields)

Optional hooks

hooks?: boolean

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

Default

true

Optional individualHooks

individualHooks?: boolean

Run before / after update hooks?. If true, this will execute a SELECT followed by individual UPDATEs. A select is needed, because the row data needs to be passed to the hooks

Default

false

Optional limit

limit?: Nullish<number | Literal>

How many rows to update

Only for mysql and mariadb, Implemented as TOP(n) for MSSQL; for sqlite it is supported only when rowid is present

Optional logging

logging?: boolean | ((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 paranoid

paranoid?: boolean

If true, only non-deleted records will be returned. If false, both deleted and non-deleted records will be returned.

Only applies if InitOptions.paranoid is true for the model.

Default

true

Optional returning

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

Return the affected rows (only for postgres)

Default

false

Optional sideEffects

sideEffects?: boolean

Whether to update the side effects of any virtual setters.

Default

true

Optional silent

silent?: boolean

If true, the updatedAt timestamp will not be updated.

Optional transaction

transaction?: null | Transaction

The transaction in which this query must be run. Mutually exclusive with Transactionable.connection.

If Options.disableClsTransactions 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 validate

validate?: boolean

Should each row be subject to validation before it is inserted. The whole insert will fail if one row fails validation.

Default

true

where

where: WhereOptions<TAttributes>

Options to describe the scope of the search.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc