Documentation
    Preparing search index...

    Interface BelongsToCreateAssociationMixinOptions<T>

    The options for the createAssociation mixin of the belongsTo association.

    BelongsToCreateAssociationMixin

    interface BelongsToCreateAssociationMixinOptions<T extends Model> {
        association?: boolean;
        benchmark?: boolean;
        connection?: AbstractConnection | null;
        fields?: (keyof Attributes<T>)[];
        hooks?: boolean;
        ignoreDuplicates?: boolean;
        include?: AllowArray<Includeable>;
        isNewRecord?: boolean;
        logging?: false | ((sql: string, timing?: number) => void);
        logQueryParameters?: boolean;
        omitNull?: boolean;
        raw?: boolean;
        returning?: boolean | (Col | Literal | keyof Attributes<T>)[];
        save?: boolean;
        searchPath?: string;
        silent?: boolean;
        transaction?: Transaction | null;
        validate?: boolean;
    }

    Type Parameters

    Hierarchy (View Summary)

    Index
    association? benchmark? connection? fields? hooks? ignoreDuplicates? include? isNewRecord? logging? logQueryParameters? omitNull? raw? returning? save? searchPath? silent? transaction? validate?
    association?: boolean
    benchmark?: boolean

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

    connection?: AbstractConnection | null

    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.

    fields?: (keyof Attributes<T>)[]

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

    hooks?: boolean

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

    true
    ignoreDuplicates?: boolean

    dialect specific ON CONFLICT DO NOTHING / INSERT IGNORE

    include?: AllowArray<Includeable>

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

    isNewRecord?: boolean

    Is this record new

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

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

    logQueryParameters?: boolean

    Log the bind parameters of the query, even if the logQueryParameters option of the Sequelize instance is disabled.

    omitNull?: boolean

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

    Defaults to the omitNull option of the model, or of the Sequelize instance if the model doesn't set it.

    raw?: boolean

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

    false
    returning?: boolean | (Col | Literal | keyof Attributes<T>)[]

    Return the affected rows (only for postgres)

    save?: boolean

    Skip saving this after setting the foreign key if false.

    searchPath?: string

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

    silent?: boolean

    If true, the updatedAt timestamp will not be updated.

    false
    transaction?: Transaction | null

    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.

    validate?: boolean

    If false, validations won't be run.

    true

    Settings
    Member Visibility

    On This Page
    Properties