Interface AbstractQueryOptions

interface AbstractQueryOptions {
    attributes?: readonly string[];
    benchmark?: boolean;
    fieldMap?: boolean | Record<string, string>;
    hasJoin?: boolean;
    hasMultiAssociation?: boolean;
    include?: boolean | IncludeOptions[];
    includeMap?: IncludeMap;
    includeNames?: readonly string[];
    instance?: Model<any, any>;
    logging?: boolean | (sql: string, timing?: number) => void;
    logQueryParameters?: boolean;
    model?: ModelStatic;
    nest?: boolean;
    originalAttributes?: readonly string[];
    plain: boolean;
    queryLabel?: string;
    raw: boolean;
    rawErrors?: boolean;
    type?: QueryTypes;
    [key: string]: unknown;
}

Indexable

  • [key: string]: unknown

Properties

attributes? benchmark? fieldMap? hasJoin? hasMultiAssociation? include? includeMap? includeNames? instance? logging? logQueryParameters? model? nest? originalAttributes? plain queryLabel? raw rawErrors? type?

Properties

Optionalattributes

attributes?: readonly string[]

The attributes currently selected by the query.

Optionalbenchmark

benchmark?: boolean

If true, emits benchmark timings instead of raw SQL logging.

OptionalfieldMap

fieldMap?: boolean | Record<string, string>

Map from raw column name to model attribute name, or true to disable.

OptionalhasJoin

hasJoin?: boolean

Internal flag indicating that the select has JOINs.

OptionalhasMultiAssociation

hasMultiAssociation?: boolean

Internal flag indicating presence of a multi association.

Optionalinclude

include?: boolean | IncludeOptions[]

Include definitions passed by the user.

OptionalincludeMap

includeMap?: IncludeMap

Resolved include map used by parser.

OptionalincludeNames

includeNames?: readonly string[]

Resolved include names used by builder.

Optionalinstance

instance?: Model<any, any>

The instance being operated on (e.g., for INSERT/UPDATE).

Optionallogging

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

Logging function or false to disable; true is deprecated.

OptionallogQueryParameters

logQueryParameters?: boolean

If true, logs bound parameter values.

Optionalmodel

model?: ModelStatic

The model associated with this query.

Optionalnest

nest?: boolean

If true, uses dotted key nesting for raw results.

OptionaloriginalAttributes

originalAttributes?: readonly string[]

The attributes originally selected by the user.

plain

plain: boolean

If true, returns only the first row (or null).

OptionalqueryLabel

queryLabel?: string

Optional label prefixed to the log line.

raw

raw: boolean

If true, returns raw objects instead of model instances.

OptionalrawErrors

rawErrors?: boolean

If true, skip error wrapping and re-throw database errors as-is.

Optionaltype

type?: QueryTypes

The query type used to adjust result processing.

Settings

Member Visibility

On This Page

Properties