Documentation
    Preparing search index...

    Interface AbstractQueryOptions

    interface AbstractQueryOptions {
        aliasesMapping?: ReadonlyMap<string, string>;
        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
    Index
    aliasesMapping? attributes? benchmark? fieldMap? hasJoin? hasMultiAssociation? include? includeMap? includeNames? instance? logging? logQueryParameters? model? nest? originalAttributes? plain queryLabel? raw rawErrors? type?
    aliasesMapping?: ReadonlyMap<string, string>

    Map from generated column aliases to their original names.

    attributes?: readonly string[]

    The attributes currently selected by the query.

    benchmark?: boolean

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

    fieldMap?: boolean | Record<string, string>

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

    hasJoin?: boolean

    Internal flag indicating that the select has JOINs.

    hasMultiAssociation?: boolean

    Internal flag indicating presence of a multi association.

    include?: boolean | IncludeOptions[]

    Include definitions passed by the user.

    includeMap?: IncludeMap

    Resolved include map used by parser.

    includeNames?: readonly string[]

    Resolved include names used by builder.

    instance?: Model<any, any>

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

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

    Logging function or false to disable; true is deprecated.

    logQueryParameters?: boolean

    If true, logs bound parameter values.

    model?: ModelStatic

    The model associated with this query.

    nest?: boolean

    If true, uses dotted key nesting for raw results.

    originalAttributes?: readonly string[]

    The attributes originally selected by the user.

    plain: boolean

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

    queryLabel?: string

    Optional label prefixed to the log line.

    raw: boolean

    If true, returns raw objects instead of model instances.

    rawErrors?: boolean

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

    type?: QueryTypes

    The query type used to adjust result processing.

    Settings
    Member Visibility

    On This Page
    Properties