Interface QueryInterfaceIndexOptions

Hierarchy

Properties

benchmark?: boolean

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

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.

concurrently?: boolean

PostgreSQL will build the index without taking any write locks. Postgres only.

Default

false

fieldMap?: FieldMap

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

fields?: (string | Fn | Literal | IndexField)[]

The fields to index.

instance?: Model<any, any>

A sequelize instance used to build the return instance

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

name?: string

The name of the index. Defaults to model name + _ + fields concatenated

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

operator?: string

Index operator type. Postgres only

parser?: null | string

For FULLTEXT columns set your parser

plain?: boolean

Sets the query type to SELECT and return a single row

prefix?: string

Prefix to append to the index name.

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?: { [key: string]: unknown }

Only named replacements are allowed in query interface methods.

Type declaration

  • [key: string]: unknown
retry?: RetryOptions
transaction?: null | Transaction

The transaction in which this query must be run.

If CLS is enabled and a transaction is running in the current CLS context, that transaction will be used, unless null or a Transaction is manually specified here.

type?: IndexType

Index type. Only used by mysql. One of UNIQUE, FULLTEXT and SPATIAL

unique?: boolean

Should the index by unique? Can also be triggered by setting type to UNIQUE

Default

false

useMaster?: boolean

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

Default

false

using?: string

The method to create the index by (USING statement in SQL). BTREE and HASH are supported by mysql and postgres. Postgres additionally supports GIST, SPGIST, BRIN and GIN.

where?: WhereOptions<any>

Optional where parameter for index. Can be used to limit the index to certain rows.

Generated using TypeDoc