Interface QueryOptionsWithType<T>

Interface for query options

Type Parameters

Hierarchy

Properties

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.

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?: boolean | ((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
        Optional

      Returns void

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

Default

false
plain?: boolean

Sets the query type to SELECT and return a single row

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

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
transaction?: Transaction

Transaction to run query under

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.

useMaster?: boolean

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

Default

false

Generated using TypeDoc