Interface CreateOptions<TAttributes>

Options for Model.create method

Type Parameters

  • TAttributes = any

Hierarchy

Properties

benchmark? fields? hooks? ignoreDuplicates? include? isNewRecord? logging? raw? returning? searchPath? silent? transaction? validate?

Properties

Optional benchmark

benchmark?: boolean

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

Optional fields

fields?: (keyof TAttributes)[]

If set, only columns matching those in fields will be saved

Optional hooks

hooks?: boolean

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

Default

true

Optional ignoreDuplicates

ignoreDuplicates?: boolean

dialect specific ON CONFLICT DO NOTHING / INSERT IGNORE

Optional include

include?: AllowArray<Includeable>

An array of include options. A single option is also supported - Used to build prefetched/included model instances. See set

Optional isNewRecord

isNewRecord?: boolean

Is this record new

Optional logging

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

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

Optional raw

raw?: boolean

If set to true, values will ignore field and virtual setters.

Default

false

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

Settings

Member Visibility

Theme

Generated using TypeDoc