Optional
benchmarkPass query execution time in milliseconds as second argument to logging function (options.logging).
Optional
bindEither 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
fieldMap returned fields to arbitrary names for SELECT query type if options.fieldMaps
is present.
Optional
instanceA sequelize instance used to build the return instance
Optional
loggingA function that gets executed while running the query to log the sql.
Optional
mapMap returned fields to model's fields if options.model
or options.instance
is present.
Mapping will occur before building the model instance.
Optional
nestIf 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
Optional
plainSets the query type to SELECT
and return a single row
Optional
rawIf true, sequelize will not try to format the results of the query, or build an instance of a model from the result
Optional
replacementsEither an object of named parameter replacements in the format :param
or an array of unnamed
replacements to replace ?
in your SQL.
Optional
retryOptional
transactionThe 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.
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
useForce the query to use the write pool, regardless of the query type.
false
Generated using TypeDoc
Options for query.