Interface QueryRawOptionsWithType<T>

Options for Sequelize#queryRaw.

interface QueryRawOptionsWithType<T> {
    [COMPLETES_TRANSACTION]?: boolean;
    benchmark?: boolean;
    bind?: BindOrReplacements;
    connection?: null | AbstractConnection;
    fieldMap?: FieldMap;
    instance?: Model<any, any>;
    logging?: false | ((sql, timing?) => void);
    mapToModel?: boolean;
    nest?: boolean;
    plain?: boolean;
    raw?: boolean;
    retry?: Options;
    supportsSearchPath?: boolean;
    transaction?: null | Transaction;
    type: T;
    useMaster?: boolean;
}

Type Parameters

Hierarchy (view full)

Properties

[COMPLETES_TRANSACTION]? benchmark? bind? connection? fieldMap? instance? logging? mapToModel? nest? plain? raw? retry? supportsSearchPath? transaction? type useMaster?

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 bind

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.

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 fieldMap

fieldMap?: FieldMap

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

Optional instance

instance?: Model<any, any>

A sequelize instance used to build the return instance

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 mapToModel

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.

Optional nest

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

Default

false

Optional plain

plain?: boolean

Sets the query type to SELECT and return a single row

Optional raw

raw?: boolean

If true, sequelize will not try to format the results of the query, or build an instance of a model from the result

Optional retry

retry?: Options

Optional supportsSearchPath

supportsSearchPath?: boolean

If false do not prepend the query with the 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.

type

type: T

The type of query you are executing. The query type affects how results are formatted before they are passed back. The type is a string, but Sequelize.QueryTypes is provided as convenience shortcuts.

Optional useMaster

useMaster?: boolean

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

Default

false

Settings

Member Visibility

Theme

On This Page

[COMPLETES_TRANSACTION]benchmarkbindconnectionfieldMapinstanceloggingmapToModelnestplainrawretrysupportsSearchPathtransactiontypeuseMaster