Version: 6.3

CountQueryBuilder <Entity>

SQL query builder with fluent interface.

const qb = orm.em.createQueryBuilder(Publisher);
qb.select('*')
  .where({
    name: 'test 123',
    type: PublisherType.GLOBAL,
  })
  .orderBy({
    name: QueryOrder.DESC,
    type: QueryOrder.ASC,
  })
  .limit(2, 1);

const publisher = await qb.getSingleResult();

Hierarchy

QueryBuilder<Entity, any, any>
- CountQueryBuilder

Accessors

alias

get alias(): string

Inherited from QueryBuilder.alias
Returns string

helper

get helper(): QueryBuilderHelper

Inherited from QueryBuilder.helper
Returns QueryBuilderHelper

mainAlias

get mainAlias(): Alias<Entity>

Inherited from QueryBuilder.mainAlias
Returns Alias<Entity>

Methods

addSelect

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

Inherited from QueryBuilder.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 QueryBuilder.andWhere
Parameters
- cond: QBFilterQuery<Entity>
Returns this

applyFilters

applyFilters(filterOptions?: boolean | string[] | Dictionary<boolean | Dictionary>): Promise<CountQueryBuilder<Entity>>

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

as

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

Inherited from QueryBuilder.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 QueryBuilder.cache
Parameters
- config: number | boolean | [string, number] = true
Returns this

clone

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

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

comment

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

Inherited from QueryBuilder.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 QueryBuilder.count
Parameters
- optionalfield: string | string[]
- distinct: boolean = false
Returns CountQueryBuilder<Entity>

delete

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

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

distinct

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

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

distinctOn

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

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

execute

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

Overrides QueryBuilder.execute
Executes this QB and returns the raw results, mapped to the property names (unless disabled via last parameter). Use method to specify what kind of result you want to get (array/single/meta).
Type parameters
- Result = { count: number }[]
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 QueryBuilder.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 QueryBuilder.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 QueryBuilder.getFormattedQuery
Returns raw interpolated query string with all the parameters inlined.
Returns string

getKnex

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

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

getKnexQuery

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

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

getLoggerContext

getLoggerContext<T>(): T

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

getParams

getParams(): readonly Value[]

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

getQuery

getQuery(): string

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

getResult

getResult(): Promise<Loaded<Entity, any>[]>

Inherited from QueryBuilder.getResult
Alias for qb.getResultList()
Returns Promise<Loaded<Entity, any>[]>

getResultAndCount

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

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

getResultList

getResultList(limit?: number): Promise<Loaded<Entity, any>[]>

Inherited from QueryBuilder.getResultList
Executes the query, returning array of results
Parameters
- optionallimit: number
Returns Promise<Loaded<Entity, any>[]>

getSingleResult

getSingleResult(): Promise<null | Entity>

Inherited from QueryBuilder.getSingleResult
Executes the query, returning the first result or null
Returns Promise<null | Entity>

groupBy

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

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

hasFlag

hasFlag(flag: QueryFlag): boolean

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

having

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

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

hintComment

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

Inherited from QueryBuilder.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 QueryBuilder.ignore
Returns this

indexHint

indexHint(sql: string): this

Inherited from QueryBuilder.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 QueryBuilder.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 QueryBuilder.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 QueryBuilder.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 QueryBuilder.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 QueryBuilder.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 QueryBuilder.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 QueryBuilder.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 QueryBuilder.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 QueryBuilder.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 QueryBuilder.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 QueryBuilder.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 QueryBuilder.limit
Parameters
- optionallimit: number
- offset: number = 0
Returns SelectQueryBuilder<Entity, any, any, never>

merge

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

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

offset

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

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

onConflict

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

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

orWhere

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

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

orderBy

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

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

returning

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

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

setFlag

setFlag(flag: QueryFlag): this

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

setFlushMode

setFlushMode(flushMode?: FlushMode): this

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

setLockMode

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

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

setLoggerContext

setLoggerContext(context: LoggingOptions & Dictionary): void

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

then

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

Overrides QueryBuilder.then
Provides promise-like interface so we can await the QB instance.
Type parameters
- TResult1 = number
- TResult2 = never
Parameters
- optionalonfulfilled: null | (value: number) => TResult1 | PromiseLike<TResult1>
- optionalonrejected: null | (reason: any) => TResult2 | PromiseLike<TResult2>
Returns Promise<number>

toQuery

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

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

truncate

truncate(): TruncateQueryBuilder<Entity>

Inherited from QueryBuilder.truncate
Returns TruncateQueryBuilder<Entity>

unsetFlag

unsetFlag(flag: QueryFlag): this

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

update

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

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

where

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

Inherited from QueryBuilder.where
Parameters
- cond: QBFilterQuery<Entity>
- optionaloperator: $and | $or
Returns this

withSchema

withSchema(schema?: string): this

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

withSubQuery

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

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

Hierarchy

Index

Accessors

Methods

Accessors

alias

Returns string

helper

Returns QueryBuilderHelper

mainAlias

Returns Alias<Entity>

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<CountQueryBuilder<Entity>>

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