Documentation
    Preparing search index...

    Interface SaveOptions<TAttributes>

    Options used for Instance.save method

    interface SaveOptions<TAttributes = any> {
        association?: boolean;
        benchmark?: boolean;
        connection?: AbstractConnection | null;
        fields?: (keyof TAttributes)[];
        hooks?: boolean;
        logging?: false | ((sql: string, timing?: number) => void);
        logQueryParameters?: boolean;
        omitNull?: boolean;
        returning?: boolean | (Col | Literal | keyof TAttributes)[];
        searchPath?: string;
        silent?: boolean;
        transaction?: Transaction | null;
        validate?: boolean;
    }

    Type Parameters

    • TAttributes = any

    Hierarchy (View Summary)

    Index
    association? benchmark? connection? fields? hooks? logging? logQueryParameters? omitNull? returning? 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 TAttributes)[]

    An optional array of strings, representing database columns. If fields is provided, only those columns will be validated and saved.

    hooks?: boolean

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

    true
    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.

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

    Return the affected rows (only for postgres)

    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