Version: 6.3

RunQueryBuilder <Entity>

Hierarchy

Omit<QueryBuilder<Entity, any, any>, getResult | getSingleResult | getResultList | where>
- RunQueryBuilder

Properties

alias

alias: string

helper

helper: QueryBuilderHelper

mainAlias

mainAlias: Alias<Entity>

Methods

addSelect

addSelect(fields: Field<Entity> | Field<Entity>[]): SelectQueryBuilder<Entity, any, any, never>

Inherited from Omit.addSelect
Parameters
- fields: Field<Entity> | Field<Entity>[]
Returns SelectQueryBuilder<Entity, any, any, never>

andWhere

andWhere(cond: QBFilterQuery<Entity>): this
andWhere(cond: string, params?: any[]): this

Inherited from Omit.andWhere
Parameters
- cond: QBFilterQuery<Entity>
Returns this

applyFilters

applyFilters(filterOptions?: boolean | string[] | Dictionary<boolean | Dictionary>): Promise<QueryBuilder<Entity, any, any, never>>

Inherited from Omit.applyFilters
Apply filters to the QB where condition.
Parameters
- filterOptions: boolean | string[] | Dictionary<boolean | Dictionary> = {}
Returns Promise<QueryBuilder<Entity, any, any, never>>

as

as(alias: string): QueryBuilder<any, any>

Inherited from Omit.as
Returns knex instance with sub-query aliased with given alias. You can provide EntityName.propName as alias, then the field name will be used based on the metadata
Parameters
- alias: string
Returns QueryBuilder<any, any>

cache

cache(config?: number | boolean | [string, number]): this

Inherited from Omit.cache
Parameters
- config: number | boolean | [string, number] = true
Returns this

clone

clone(reset?: boolean | string[]): QueryBuilder<Entity, never, never, never>

Inherited from Omit.clone
Parameters
- optionalreset: boolean | string[]
Returns QueryBuilder<Entity, never, never, never>

comment

comment(comment: string | string[]): this

Inherited from Omit.comment
Prepend comment to the sql query using the syntax /* ... *‍/. Some characters are forbidden such as /*, *‍/ and ?.
Parameters
- comment: string | string[]
Returns this

count

count(field?: string | string[], distinct?: boolean): CountQueryBuilder<Entity>

Inherited from Omit.count
Parameters
- optionalfield: string | string[]
- distinct: boolean = false
Returns CountQueryBuilder<Entity>

delete

delete(cond?: QBFilterQuery): DeleteQueryBuilder<Entity>

Inherited from Omit.delete
Parameters
- optionalcond: QBFilterQuery
Returns DeleteQueryBuilder<Entity>

distinct

distinct(): SelectQueryBuilder<Entity, any, any, never>

Inherited from Omit.distinct
Returns SelectQueryBuilder<Entity, any, any, never>

distinctOn

distinctOn(fields: string | string[]): SelectQueryBuilder<Entity, any, any, never>

Inherited from Omit.distinctOn
postgres only
Parameters
- fields: string | string[]
Returns SelectQueryBuilder<Entity, any, any, never>

execute

execute<Result>(method?: get | all | run, mapResults?: boolean): Promise<Result>

Overrides Omit.execute
Type parameters
- Result = QueryResult<Entity>
Parameters
- optionalmethod: get | all | run
- optionalmapResults: boolean
Returns Promise<Result>

from

from<Entity>(target: QueryBuilder<Entity, never, never, never>, aliasName?: string): SelectQueryBuilder<Entity, any, any, never>
from<Entity>(target: EntityName<Entity>): SelectQueryBuilder<Entity, any, any, never>

Inherited from Omit.from
Specifies FROM which entity's table select/update/delete will be executed, removing all previously set FROM-s. Allows setting a main string alias of the selection data.
Type parameters
- Entity: Partial<Entity> = Partial<any>
Parameters
- target: QueryBuilder<Entity, never, never, never>
- optionalaliasName: string
Returns SelectQueryBuilder<Entity, any, any, never>

getCount

getCount(field?: string | string[], distinct?: boolean): Promise<number>

Inherited from Omit.getCount
Executes count query (without offset and limit), returning total count of results
Parameters
- optionalfield: string | string[]
- optionaldistinct: boolean
Returns Promise<number>

getFormattedQuery

getFormattedQuery(): string

Inherited from Omit.getFormattedQuery
Returns raw interpolated query string with all the parameters inlined.
Returns string

getKnex

getKnex(processVirtualEntity?: boolean): QueryBuilder<any, any>

Inherited from Omit.getKnex
Parameters
- processVirtualEntity: boolean = true
Returns QueryBuilder<any, any>

getKnexQuery

getKnexQuery(processVirtualEntity?: boolean): QueryBuilder<any, any>

Inherited from Omit.getKnexQuery
Parameters
- processVirtualEntity: boolean = true
Returns QueryBuilder<any, any>

getLoggerContext

getLoggerContext<T>(): T

Inherited from Omit.getLoggerContext
Gets logger context for this query builder.
Type parameters
- T: Dictionary & LoggingOptions = Dictionary
Returns T

getParams

getParams(): readonly Value[]

Inherited from Omit.getParams
Returns the list of all parameters for this query.
Returns readonly Value[]

getQuery

getQuery(): string

Inherited from Omit.getQuery
Returns the query with parameters as wildcards.
Returns string

getResultAndCount

getResultAndCount(): Promise<[Entity[], number]>

Inherited from Omit.getResultAndCount
Executes the query, returning both array of results and total count query (without offset and limit).
Returns Promise<[Entity[], number]>

groupBy

groupBy(fields: string | keyof Entity | readonly (string | keyof Entity)[]): SelectQueryBuilder<Entity, any, any, never>

Inherited from Omit.groupBy
Parameters
- fields: string | keyof Entity | readonly (string | keyof Entity)[]
Returns SelectQueryBuilder<Entity, any, any, never>

hasFlag

hasFlag(flag: QueryFlag): boolean

Inherited from Omit.hasFlag
Parameters
- flag: QueryFlag
Returns boolean

having

having(cond?: string | QBFilterQuery, params?: any[]): SelectQueryBuilder<Entity, any, any, never>

Inherited from Omit.having
Parameters
- cond: string | QBFilterQuery = {}
- optionalparams: any[]
Returns SelectQueryBuilder<Entity, any, any, never>

hintComment

hintComment(comment: string | string[]): this

Inherited from Omit.hintComment
Add hints to the query using comment-like syntax /*+ ... *‍/. MySQL and Oracle use this syntax for optimizer hints. Also various DB proxies and routers use this syntax to pass hints to alter their behavior. In other dialects the hints are ignored as simple comments.
Parameters
- comment: string | string[]
Returns this

ignore

ignore(): this

Inherited from Omit.ignore
Returns this

indexHint

indexHint(sql: string): this

Inherited from Omit.indexHint
Adds index hint to the FROM clause.
Parameters
- sql: string
Returns this

innerJoin

innerJoin<Field, Alias>(field: QueryBuilder<any, any> | QueryBuilder<any, never, never, never> | Field, alias: Alias, cond?: QBFilterQuery, schema?: string): SelectQueryBuilder<Entity, any, any, { [ K in string ]: AddToContext<GetType<Entity, object, Field>, object, Field, Alias, false>[K] }>

Inherited from Omit.innerJoin
Type parameters
- Field: string | AnyString
- Alias: string
Parameters
- field: QueryBuilder<any, any> | QueryBuilder<any, never, never, never> | Field
- alias: Alias
- cond: QBFilterQuery = {}
- optionalschema: string
Returns SelectQueryBuilder<Entity, any, any, { [ K in string ]: AddToContext<GetType<Entity, object, Field>, object, Field, Alias, false>[K] }>

innerJoinAndSelect

innerJoinAndSelect<Field, Alias>(field: Field | [field: Field, qb: QueryBuilder<any, any> | QueryBuilder<any, never, never, never>], alias: Alias, cond?: QBFilterQuery, fields?: string[], schema?: string): SelectQueryBuilder<Entity, any, any, { [ K in string ]: AddToContext<GetType<Entity, object, Field>, object, Field, Alias, true>[K] }>

Inherited from Omit.innerJoinAndSelect
Type parameters
- Field: string | AnyString
- Alias: string
Parameters
- field: Field | [field: Field, qb: QueryBuilder<any, any> | QueryBuilder<any, never, never, never>]
- alias: Alias
- cond: QBFilterQuery = {}
- optionalfields: string[]
- optionalschema: string
Returns SelectQueryBuilder<Entity, any, any, { [ K in string ]: AddToContext<GetType<Entity, object, Field>, object, Field, Alias, true>[K] }>

innerJoinLateral

innerJoinLateral(field: QueryBuilder<any, any> | QueryBuilder<any, never, never, never>, alias: string, cond?: QBFilterQuery, schema?: string): this

Inherited from Omit.innerJoinLateral
Parameters
- field: QueryBuilder<any, any> | QueryBuilder<any, never, never, never>
- alias: string
- cond: QBFilterQuery = {}
- optionalschema: string
Returns this

innerJoinLateralAndSelect

innerJoinLateralAndSelect<Field, Alias>(field: [field: Field, qb: QueryBuilder<any, any> | QueryBuilder<any, never, never, never>], alias: Alias, cond?: QBFilterQuery, fields?: string[], schema?: string): SelectQueryBuilder<Entity, any, any, { [ K in string ]: AddToContext<GetType<Entity, object, Field>, object, Field, Alias, true>[K] }>

Inherited from Omit.innerJoinLateralAndSelect
Type parameters
- Field: string | AnyString
- Alias: string
Parameters
- field: [field: Field, qb: QueryBuilder<any, any> | QueryBuilder<any, never, never, never>]
- alias: Alias
- cond: QBFilterQuery = {}
- optionalfields: string[]
- optionalschema: string
Returns SelectQueryBuilder<Entity, any, any, { [ K in string ]: AddToContext<GetType<Entity, object, Field>, object, Field, Alias, true>[K] }>

insert

insert(data: RequiredEntityData<Entity> | RequiredEntityData<Entity>[]): InsertQueryBuilder<Entity>

Inherited from Omit.insert
Parameters
- data: RequiredEntityData<Entity> | RequiredEntityData<Entity>[]
Returns InsertQueryBuilder<Entity>

join

join<Field, Alias>(field: QueryBuilder<any, any> | QueryBuilder<any, never, never, never> | Field, alias: Alias, cond?: QBFilterQuery, type?: JoinType, path?: string, schema?: string): SelectQueryBuilder<Entity, any, any, { [ K in string ]: AddToContext<GetType<Entity, object, Field>, object, Field, Alias, false>[K] }>

Inherited from Omit.join
Type parameters
- Field: string | AnyString
- Alias: string
Parameters
- field: QueryBuilder<any, any> | QueryBuilder<any, never, never, never> | Field
- alias: Alias
- cond: QBFilterQuery = {}
- type: JoinType = JoinType.innerJoin
- optionalpath: string
- optionalschema: string
Returns SelectQueryBuilder<Entity, any, any, { [ K in string ]: AddToContext<GetType<Entity, object, Field>, object, Field, Alias, false>[K] }>

joinAndSelect

joinAndSelect<Field, Alias>(field: Field | [field: Field, qb: QueryBuilder<any, any> | QueryBuilder<any, never, never, never>], alias: Alias, cond?: QBFilterQuery, type?: JoinType, path?: string, fields?: string[], schema?: string): SelectQueryBuilder<Entity, any, any, { [ K in string ]: AddToContext<GetType<Entity, object, Field>, object, Field, Alias, true>[K] }>

Inherited from Omit.joinAndSelect
Type parameters
- Field: string | AnyString
- Alias: string
Parameters
- field: Field | [field: Field, qb: QueryBuilder<any, any> | QueryBuilder<any, never, never, never>]
- alias: Alias
- cond: QBFilterQuery = {}
- type: JoinType = JoinType.innerJoin
- optionalpath: string
- optionalfields: string[]
- optionalschema: string
Returns SelectQueryBuilder<Entity, any, any, { [ K in string ]: AddToContext<GetType<Entity, object, Field>, object, Field, Alias, true>[K] }>

leftJoin

leftJoin<Field, Alias>(field: QueryBuilder<any, any> | QueryBuilder<any, never, never, never> | Field, alias: Alias, cond?: QBFilterQuery, schema?: string): SelectQueryBuilder<Entity, any, any, { [ K in string ]: AddToContext<GetType<Entity, object, Field>, object, Field, Alias, false>[K] }>

Inherited from Omit.leftJoin
Type parameters
- Field: string | AnyString
- Alias: string
Parameters
- field: QueryBuilder<any, any> | QueryBuilder<any, never, never, never> | Field
- alias: Alias
- cond: QBFilterQuery = {}
- optionalschema: string
Returns SelectQueryBuilder<Entity, any, any, { [ K in string ]: AddToContext<GetType<Entity, object, Field>, object, Field, Alias, false>[K] }>

leftJoinAndSelect

leftJoinAndSelect<Field, Alias>(field: Field | [field: Field, qb: QueryBuilder<any, any> | QueryBuilder<any, never, never, never>], alias: Alias, cond?: QBFilterQuery, fields?: string[], schema?: string): SelectQueryBuilder<Entity, any, any, { [ K in string ]: AddToContext<GetType<Entity, object, Field>, object, Field, Alias, true>[K] }>

Inherited from Omit.leftJoinAndSelect
Type parameters
- Field: string | AnyString
- Alias: string
Parameters
- field: Field | [field: Field, qb: QueryBuilder<any, any> | QueryBuilder<any, never, never, never>]
- alias: Alias
- cond: QBFilterQuery = {}
- optionalfields: string[]
- optionalschema: string
Returns SelectQueryBuilder<Entity, any, any, { [ K in string ]: AddToContext<GetType<Entity, object, Field>, object, Field, Alias, true>[K] }>

leftJoinLateral

leftJoinLateral(field: QueryBuilder<any, any> | QueryBuilder<any, never, never, never>, alias: string, cond?: QBFilterQuery, schema?: string): this

Inherited from Omit.leftJoinLateral
Parameters
- field: QueryBuilder<any, any> | QueryBuilder<any, never, never, never>
- alias: string
- cond: QBFilterQuery = {}
- optionalschema: string
Returns this

leftJoinLateralAndSelect

leftJoinLateralAndSelect<Field, Alias>(field: [field: Field, qb: QueryBuilder<any, any> | QueryBuilder<any, never, never, never>], alias: Alias, cond?: QBFilterQuery, fields?: string[], schema?: string): SelectQueryBuilder<Entity, any, any, { [ K in string ]: AddToContext<GetType<Entity, object, Field>, object, Field, Alias, true>[K] }>

Inherited from Omit.leftJoinLateralAndSelect
Type parameters
- Field: string | AnyString
- Alias: string
Parameters
- field: [field: Field, qb: QueryBuilder<any, any> | QueryBuilder<any, never, never, never>]
- alias: Alias
- cond: QBFilterQuery = {}
- optionalfields: string[]
- optionalschema: string
Returns SelectQueryBuilder<Entity, any, any, { [ K in string ]: AddToContext<GetType<Entity, object, Field>, object, Field, Alias, true>[K] }>

limit

limit(limit?: number, offset?: number): SelectQueryBuilder<Entity, any, any, never>

Inherited from Omit.limit
Parameters
- optionallimit: number
- offset: number = 0
Returns SelectQueryBuilder<Entity, any, any, never>

merge

merge(data?: Field<Entity>[] | EntityData<Entity>): this

Inherited from Omit.merge
Parameters
- optionaldata: Field<Entity>[] | EntityData<Entity>
Returns this

offset

offset(offset?: number): SelectQueryBuilder<Entity, any, any, never>

Inherited from Omit.offset
Parameters
- optionaloffset: number
Returns SelectQueryBuilder<Entity, any, any, never>

onConflict

onConflict(fields?: Field<Entity> | Field<Entity>[]): InsertQueryBuilder<Entity>

Inherited from Omit.onConflict
Parameters
- fields: Field<Entity> | Field<Entity>[] = []
Returns InsertQueryBuilder<Entity>

orWhere

orWhere(cond: QBFilterQuery<Entity>): this
orWhere(cond: string, params?: any[]): this

Inherited from Omit.orWhere
Parameters
- cond: QBFilterQuery<Entity>
Returns this

orderBy

orderBy(orderBy: QBQueryOrderMap<Entity> | QBQueryOrderMap<Entity>[]): SelectQueryBuilder<Entity, any, any, never>

Inherited from Omit.orderBy
Parameters
- orderBy: QBQueryOrderMap<Entity> | QBQueryOrderMap<Entity>[]
Returns SelectQueryBuilder<Entity, any, any, never>

returning

returning(fields?: Field<Entity> | Field<Entity>[]): this

Inherited from Omit.returning
Parameters
- optionalfields: Field<Entity> | Field<Entity>[]
Returns this

select

select(fields: Field<Entity> | Field<Entity>[], distinct?: boolean): SelectQueryBuilder<Entity, any, any, never>

Inherited from Omit.select
Parameters
- fields: Field<Entity> | Field<Entity>[]
- distinct: boolean = false
Returns SelectQueryBuilder<Entity, any, any, never>

setFlag

setFlag(flag: QueryFlag): this

Inherited from Omit.setFlag
Parameters
- flag: QueryFlag
Returns this

setFlushMode

setFlushMode(flushMode?: FlushMode): this

Inherited from Omit.setFlushMode
Parameters
- optionalflushMode: FlushMode
Returns this

setLockMode

setLockMode(mode?: LockMode, tables?: string[]): this

Inherited from Omit.setLockMode
Parameters
- optionalmode: LockMode
- optionaltables: string[]
Returns this

setLoggerContext

setLoggerContext(context: LoggingOptions & Dictionary): void

Inherited from Omit.setLoggerContext
Sets logger context for this query builder.
Parameters
- context: LoggingOptions & Dictionary
Returns void

then

then<TResult1, TResult2>(onfulfilled?: null | (value: QueryResult<Entity>) => TResult1 | PromiseLike<TResult1>, onrejected?: null | (reason: any) => TResult2 | PromiseLike<TResult2>): Promise<QueryResult<Entity>>

Overrides Omit.then
Type parameters
- TResult1 = QueryResult<Entity>
- TResult2 = never
Parameters
- optionalonfulfilled: null | (value: QueryResult<Entity>) => TResult1 | PromiseLike<TResult1>
- optionalonrejected: null | (reason: any) => TResult2 | PromiseLike<TResult2>
Returns Promise<QueryResult<Entity>>

toQuery

toQuery(): { _sql: Sql; params: readonly unknown[]; sql: string }

Inherited from Omit.toQuery
Returns { _sql: Sql; params: readonly unknown[]; sql: string }
- _sql: Sql
- params: readonly unknown[]
- sql: string

truncate

truncate(): TruncateQueryBuilder<Entity>

Inherited from Omit.truncate
Returns TruncateQueryBuilder<Entity>

unsetFlag

unsetFlag(flag: QueryFlag): this

Inherited from Omit.unsetFlag
Parameters
- flag: QueryFlag
Returns this

update

update(data: EntityData<Entity>): UpdateQueryBuilder<Entity>

Inherited from Omit.update
Parameters
- data: EntityData<Entity>
Returns UpdateQueryBuilder<Entity>

where

where(cond: string | QBFilterQuery<Entity>, params?: any[] | $and | $or, operator?: $and | $or): this

Parameters
- cond: string | QBFilterQuery<Entity>
- optionalparams: any[] | $and | $or
- optionaloperator: $and | $or
Returns this

withSchema

withSchema(schema?: string): this

Inherited from Omit.withSchema
Parameters
- optionalschema: string
Returns this

withSubQuery

withSubQuery(subQuery: QueryBuilder<any, any>, alias: string): this

Inherited from Omit.withSubQuery
Parameters
- subQuery: QueryBuilder<any, any>
- alias: string
Returns this

Hierarchy

Index

Properties

Methods

Properties

alias

helper

mainAlias

Methods

addSelect

Parameters

fields: Field<Entity> | Field<Entity>[]

Returns SelectQueryBuilder<Entity, any, any, never>

andWhere

Parameters

cond: QBFilterQuery<Entity>

Returns this

applyFilters

Parameters

filterOptions: boolean | string[] | Dictionary<boolean | Dictionary> = {}

Returns Promise<QueryBuilder<Entity, any, any, never>>

as

Parameters

alias: string

Returns QueryBuilder<any, any>

cache

Parameters

config: number | boolean | [string, number] = true

Returns this

clone

Parameters

optionalreset: boolean | string[]

Returns QueryBuilder<Entity, never, never, never>

comment

Parameters

comment: string | string[]

Returns this

count

Parameters

optionalfield: string | string[]

distinct: boolean = false

Returns CountQueryBuilder<Entity>

delete

Parameters

optionalcond: QBFilterQuery

Returns DeleteQueryBuilder<Entity>

distinct

Returns SelectQueryBuilder<Entity, any, any, never>

distinctOn

Parameters

fields: string | string[]

Returns SelectQueryBuilder<Entity, any, any, never>

execute

Type parameters

Parameters

optionalmethod: get | all | run

optionalmapResults: boolean

Returns Promise<Result>

from

Type parameters

Parameters

target: QueryBuilder<Entity, never, never, never>

optionalaliasName: string

Returns SelectQueryBuilder<Entity, any, any, never>

getCount

Parameters

optionalfield: string | string[]

optionaldistinct: boolean

Returns Promise<number>

getFormattedQuery

Returns string

getKnex

Parameters

processVirtualEntity: boolean = true

Returns QueryBuilder<any, any>

getKnexQuery

Parameters

processVirtualEntity: boolean = true

Returns QueryBuilder<any, any>

getLoggerContext