Interface BulkCreateOptions<TAttributes>

Options for Model.bulkCreate method

interface BulkCreateOptions<TAttributes> {
    [COMPLETES_TRANSACTION]?: boolean;
    benchmark?: boolean;
    conflictAttributes?: (keyof TAttributes)[];
    conflictWhere?: WhereOptions<TAttributes>;
    connection?: null | AbstractConnection;
    fields?: (keyof TAttributes)[];
    hooks?: boolean;
    ignoreDuplicates?: boolean;
    include?: AllowArray<Includeable>;
    individualHooks?: boolean;
    logging?: false | ((sql, timing?) => void);
    returning?: boolean | (Col | Literal | keyof TAttributes)[];
    searchPath?: string;
    transaction?: null | Transaction;
    updateOnDuplicate?: (keyof TAttributes)[];
    validate?: boolean;
}

Type Parameters

  • TAttributes = any

Hierarchy (view full)

Properties

[COMPLETES_TRANSACTION]? benchmark? conflictAttributes? conflictWhere? connection? fields? hooks? ignoreDuplicates? include? individualHooks? logging? returning? searchPath? transaction? updateOnDuplicate? validate?

Properties

Private Optional [COMPLETES_TRANSACTION]

[COMPLETES_TRANSACTION]?: boolean

Indicates if the query completes the transaction Internal only

Optional benchmark

benchmark?: boolean

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

Optional conflictAttributes

conflictAttributes?: (keyof TAttributes)[]

Optional override for the conflict fields in the ON CONFLICT part of the query. Only supported in Postgres >= 9.5 and SQLite >= 3.24.0

Optional conflictWhere

conflictWhere?: WhereOptions<TAttributes>

An optional parameter to specify a where clause for partial unique indexes (note: ON CONFLICT WHERE not ON CONFLICT DO UPDATE WHERE). Only supported in Postgres >= 9.5 and sqlite >= 9.5

Optional connection

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.

Optional fields

fields?: (keyof TAttributes)[]

Fields to insert (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 ignoreDuplicates

ignoreDuplicates?: boolean

Ignore duplicate values for primary keys?

Default

false

Optional include

include?: AllowArray<Includeable>

Include options. See find for details

Optional individualHooks

individualHooks?: boolean

Run before / after create hooks for each individual Instance? BulkCreate hooks will still be run if BulkCreateOptions.hooks is true.

Default

false

Optional logging

logging?: false | ((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 returning

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

Return all columns or only the specified columns for the affected rows (only for postgres)

Optional searchPath

searchPath?: string

An optional parameter to specify the schema search_path (Postgres only)

Optional transaction

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.

Optional updateOnDuplicate

updateOnDuplicate?: (keyof TAttributes)[]

Fields to update if row key already exists (on duplicate key update)? (only supported by MySQL, MariaDB, SQLite >= 3.24.0 & Postgres >= 9.5).

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

false

Settings

Member Visibility

Theme

On This Page

[COMPLETES_TRANSACTION]benchmarkconflictAttributesconflictWhereconnectionfieldshooksignoreDuplicatesincludeindividualHooksloggingreturningsearchPathtransactionupdateOnDuplicatevalidate