Interface createOptions

interface createOptions {
    benchmark?: boolean | sequelizeFunc<undefined> | sequelizeFunc<false> | sequelizeFunc<true>;
    creatableFields?: customFields;
    fields?: sequelizeFunc<undefined> | never[] | sequelizeFunc<never[]>;
    hooks?: boolean | sequelizeFunc<undefined> | sequelizeFunc<false> | sequelizeFunc<true>;
    ignoreDuplicates?: boolean | sequelizeFunc<undefined> | sequelizeFunc<false> | sequelizeFunc<true>;
    include?: string | ModelType<any, any> | Association<Model<any, any>, Model<any, any>> | IncludeOptions | {
        all: true;
        nested?: true;
    } | Includeable[] | sequelizeFunc<undefined> | sequelizeFunc<string> | sequelizeFunc<ModelType<any, any>> | sequelizeFunc<Association<Model<any, any>, Model<any, any>>> | sequelizeFunc<IncludeOptions> | sequelizeFunc<{
        all: true;
        nested?: true;
    }> | sequelizeFunc<Includeable[]>;
    isNewRecord?: boolean | sequelizeFunc<undefined> | sequelizeFunc<false> | sequelizeFunc<true>;
    logging?: boolean | sequelizeFunc<undefined> | sequelizeFunc<false> | sequelizeFunc<true> | ((sql, timing?) => void) | sequelizeFunc<((sql, timing?) => void)>;
    middleware?: expressFunc;
    raw?: boolean | sequelizeFunc<undefined> | sequelizeFunc<false> | sequelizeFunc<true>;
    returning?: boolean | sequelizeFunc<undefined> | sequelizeFunc<false> | sequelizeFunc<true> | never[] | sequelizeFunc<never[]>;
    silent?: boolean | sequelizeFunc<undefined> | sequelizeFunc<false> | sequelizeFunc<true>;
    validate?: boolean | sequelizeFunc<undefined> | sequelizeFunc<false> | sequelizeFunc<true>;
}

Hierarchy (view full)

  • operationFieldCore
  • expressCrudProps<Omit<CreateOptions<unknown>, "transaction">>
    • createOptions

Properties

benchmark? creatableFields? fields? hooks? ignoreDuplicates? include? isNewRecord? logging? middleware? raw? returning? silent? validate?

Properties

Optional benchmark

benchmark?: boolean | sequelizeFunc<undefined> | sequelizeFunc<false> | sequelizeFunc<true>

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

Optional creatableFields

creatableFields?: customFields

Optional fields

fields?: sequelizeFunc<undefined> | never[] | sequelizeFunc<never[]>

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

Optional hooks

hooks?: boolean | sequelizeFunc<undefined> | sequelizeFunc<false> | sequelizeFunc<true>

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

Optional ignoreDuplicates

ignoreDuplicates?: boolean | sequelizeFunc<undefined> | sequelizeFunc<false> | sequelizeFunc<true>

dialect specific ON CONFLICT DO NOTHING / INSERT IGNORE

Optional include

include?: string | ModelType<any, any> | Association<Model<any, any>, Model<any, any>> | IncludeOptions | {
    all: true;
    nested?: true;
} | Includeable[] | sequelizeFunc<undefined> | sequelizeFunc<string> | sequelizeFunc<ModelType<any, any>> | sequelizeFunc<Association<Model<any, any>, Model<any, any>>> | sequelizeFunc<IncludeOptions> | sequelizeFunc<{
    all: true;
    nested?: true;
}> | sequelizeFunc<Includeable[]>

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

TODO: See set

Type declaration

  • all: true
  • Optional nested?: true

Optional isNewRecord

isNewRecord?: boolean | sequelizeFunc<undefined> | sequelizeFunc<false> | sequelizeFunc<true>

Is this record new

Optional logging

logging?: boolean | sequelizeFunc<undefined> | sequelizeFunc<false> | sequelizeFunc<true> | ((sql, timing?) => void) | sequelizeFunc<((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 middleware

middleware?: expressFunc

Optional raw

raw?: boolean | sequelizeFunc<undefined> | sequelizeFunc<false> | sequelizeFunc<true>

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

Optional returning

returning?: boolean | sequelizeFunc<undefined> | sequelizeFunc<false> | sequelizeFunc<true> | never[] | sequelizeFunc<never[]>

Return the affected rows (only for postgres)

Optional silent

silent?: boolean | sequelizeFunc<undefined> | sequelizeFunc<false> | sequelizeFunc<true>

If true, the updatedAt timestamp will not be updated.

Default

false

Optional validate

validate?: boolean | sequelizeFunc<undefined> | sequelizeFunc<false> | sequelizeFunc<true>

If false, validations won't be run.

Default

true

Settings

Member Visibility

Theme

On This Page

benchmarkcreatableFieldsfieldshooksignoreDuplicatesincludeisNewRecordloggingmiddlewarerawreturningsilentvalidate