Interface CreateOptions<TAttributes>

Options for Model.create method

interface CreateOptions<TAttributes = any> {
    benchmark?: boolean;
    connection?: null | AbstractConnection;
    fields?: (keyof TAttributes)[];
    hooks?: boolean;
    ignoreDuplicates?: boolean;
    include?: AllowArray<Includeable>;
    isNewRecord?: boolean;
    logging?: false | (sql: string, timing?: number) => void;
    raw?: boolean;
    returning?: boolean | (Col | Literal | keyof TAttributes)[];
    searchPath?: string;
    silent?: boolean;
    transaction?: null | Transaction;
    validate?: boolean;
}

Type Parameters

  • TAttributes = any

Hierarchy (View Summary)

Properties

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

Properties

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)[]

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

Optionalhooks

hooks?: boolean

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

Default

true

OptionalignoreDuplicates

ignoreDuplicates?: boolean

dialect specific ON CONFLICT DO NOTHING / INSERT IGNORE

Optionalinclude

include?: AllowArray<Includeable>

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

OptionalisNewRecord

isNewRecord?: boolean

Is this record new

Optionallogging

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

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

Optionalraw

raw?: boolean

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

Default

false

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

Settings

Member Visibility

On This Page

Properties