Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SaveOptions<TAttributes>

Options used for Instance.save method

Type parameters

  • TAttributes = any

Hierarchy

Index

Properties

benchmark?: boolean

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

fields?: keyof TAttributes[]

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

hooks?: boolean

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

default

true

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

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

omitNull?: boolean

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

default

false

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

default

false

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.

validate?: boolean

If false, validations won't be run.

default

true

Generated using TypeDoc