Documentation
    Preparing search index...

    Interface SetSessionVariablesOptions

    interface SetSessionVariablesOptions {
        benchmark?: boolean;
        bind?: BindOrReplacements;
        connection?: AbstractConnection | null;
        fieldMap?: FieldMap;
        instance?: Model<any, any>;
        logging?: false | ((sql: string, timing?: number) => void);
        mapToModel?: boolean;
        nest?: boolean;
        replacements?: BindOrReplacements;
        retry?: Options;
        supportsSearchPath?: boolean;
        transaction?: Transaction | null;
        useMaster?: boolean;
    }

    Hierarchy

    Index
    benchmark? bind? connection? fieldMap? instance? logging? mapToModel? nest? replacements? retry? supportsSearchPath? transaction? useMaster?
    benchmark?: boolean

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

    bind?: BindOrReplacements

    Either an object of named parameter bindings in the format $param or an array of unnamed values to bind to $1, $2, etc in your SQL.

    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.

    fieldMap?: FieldMap

    Map returned fields to arbitrary names for SELECT query type if options.fieldMaps is present.

    instance?: Model<any, any>

    A sequelize instance used to build the return instance

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

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

    mapToModel?: boolean

    Map returned fields to model's fields if options.model or options.instance is present. Mapping will occur before building the model instance.

    nest?: boolean

    If true, transforms objects with . separated property names into nested objects using dottie.js. For example { 'user.username': 'john' } becomes { user: { username: 'john' }}. When nest is true, the query type is assumed to be 'SELECT', unless otherwise specified

    false
    replacements?: BindOrReplacements

    Either an object of named parameter replacements in the format :param or an array of unnamed replacements to replace ? in your SQL.

    retry?: Options
    supportsSearchPath?: boolean

    If false do not prepend the query with the search_path (Postgres only)

    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.

    useMaster?: boolean

    Force the query to use the write pool, regardless of the query type.

    false

    Settings
    Member Visibility

    On This Page
    Properties