Version: 6.4

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

inheritedalias

get alias(): string

Inherited from QueryBuilder.alias
Returns string

inheritedhelper

get helper(): QueryBuilderHelper

Inherited from QueryBuilder.helper
Returns QueryBuilderHelper

inheritedmainAlias

get mainAlias(): Alias<Entity>

Inherited from QueryBuilder.mainAlias
Returns Alias<Entity>

Methods

inheritedaddSelect

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>

inheritedandHaving

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

Inherited from QueryBuilder.andHaving
Parameters
- optionalcond: string | QBFilterQuery
- optionalparams: any[]
Returns SelectQueryBuilder<Entity, any, any, never>

inheritedandWhere

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

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

inheritedapplyFilters

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

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

inheritedas

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>

inheritedcache

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

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

inheritedclone

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

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

inheritedcomment

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

inheritedcount

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

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

inheriteddelete

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

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

inheriteddistinct

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

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

inheriteddistinctOn

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

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

execute

execute(method?: get | all | run, mapResults?: boolean): Promise<Result>
execute(method: all, mapResults?: boolean): Promise<Result>
execute(method: get, mapResults?: boolean): Promise<Result>
execute(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).
Parameters
- optionalmethod: get | all | run
- optionalmapResults: boolean
Returns Promise<Result>

inheritedfrom

from(target: QueryBuilder<Entity, never, never, never>, aliasName?: string): SelectQueryBuilder<Entity, any, any, never>
from(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.
Parameters
- target: QueryBuilder<Entity, never, never, never>
- optionalaliasName: string
Returns SelectQueryBuilder<Entity, any, any, never>

inheritedgetCount

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

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

inheritedgetFormattedQuery

getFormattedQuery(): string

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

inheritedgetKnex

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

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

inheritedgetKnexQuery

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

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

inheritedgetLoggerContext

getLoggerContext(): T

Inherited from QueryBuilder.getLoggerContext
Gets logger context for this query builder.
Returns T

inheritedgetParams

getParams(): readonly Value[]

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

inheritedgetQuery

getQuery(): string

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

inheritedgetResult

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

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

inheritedgetResultAndCount

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]>

inheritedgetResultList

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>[]>

inheritedgetSingleResult

getSingleResult(): Promise<null | Entity>

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

inheritedgroupBy

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

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

inheritedhasFlag

hasFlag(flag: QueryFlag): boolean

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

inheritedhaving

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

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

inheritedhintComment

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

inheritedignore

ignore(): this

Inherited from QueryBuilder.ignore
Returns this

inheritedindexHint

indexHint(sql: string): this

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

inheritedinnerJoin

innerJoin(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
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] }>

inheritedinnerJoinAndSelect

innerJoinAndSelect(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
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] }>

inheritedinnerJoinLateral

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

inheritedinnerJoinLateralAndSelect

innerJoinLateralAndSelect(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
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] }>

inheritedinsert

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

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

inheritedjoin

join(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
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] }>

inheritedjoinAndSelect

joinAndSelect(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
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] }>

inheritedleftJoin

leftJoin(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
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] }>

inheritedleftJoinAndSelect

leftJoinAndSelect(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
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] }>

inheritedleftJoinLateral

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

inheritedleftJoinLateralAndSelect

leftJoinLateralAndSelect(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
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] }>

inheritedlimit

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>

inheritedmerge

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

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

inheritedoffset

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

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

inheritedonConflict

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

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

inheritedorderBy

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>

inheritedorHaving

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

Inherited from QueryBuilder.orHaving
Parameters
- optionalcond: string | QBFilterQuery
- optionalparams: any[]
Returns SelectQueryBuilder<Entity, any, any, never>

inheritedorWhere

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

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

inheritedreturning

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

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

inheritedselect

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>

inheritedsetFlag

setFlag(flag: QueryFlag): this

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

inheritedsetFlushMode

setFlushMode(flushMode?: FlushMode): this

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

inheritedsetLockMode

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

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

inheritedsetLoggerContext

setLoggerContext(context: LoggingOptions & Dictionary): void

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

then

then(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.
Parameters
- optionalonfulfilled: null | (value: number) => TResult1 | PromiseLike<TResult1>
- optionalonrejected: null | (reason: any) => TResult2 | PromiseLike<TResult2>
Returns Promise<number>

inheritedtoQuery

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

inheritedtruncate

truncate(): TruncateQueryBuilder<Entity>

Inherited from QueryBuilder.truncate
Returns TruncateQueryBuilder<Entity>

inheritedunsetFlag

unsetFlag(flag: QueryFlag): this

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

inheritedupdate

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

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

inheritedwhere

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

inheritedwithSchema

withSchema(schema?: string): this

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

inheritedwithSubQuery

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

inheritedalias

Returns string

inheritedhelper

Returns QueryBuilderHelper

inheritedmainAlias

Returns Alias<Entity>

Methods

inheritedaddSelect

Parameters

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

Returns SelectQueryBuilder<Entity, any, any, never>

inheritedandHaving

Parameters

optionalcond: string | QBFilterQuery

optionalparams: any[]

Returns SelectQueryBuilder<Entity, any, any, never>

inheritedandWhere

Parameters

cond: QBFilterQuery<Entity>

Returns this

inheritedapplyFilters

Parameters

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

Returns Promise<void>

inheritedas

Parameters

alias: string

Returns QueryBuilder<any, any>

inheritedcache

Parameters

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

Returns this

inheritedclone

Parameters

optionalreset: boolean | string[]

Returns QueryBuilder<Entity, never, never, never>

inheritedcomment

Parameters

comment: string | string[]

Returns this

inheritedcount

Parameters

optionalfield: EntityKeyOrString<Entity> | EntityKeyOrString<Entity>[]

distinct: boolean = false

Returns CountQueryBuilder<Entity>

inheriteddelete

Parameters

optionalcond: QBFilterQuery

Returns DeleteQueryBuilder<Entity>

inheriteddistinct

Returns SelectQueryBuilder<Entity, any, any, never>

inheriteddistinctOn

Parameters

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

Returns SelectQueryBuilder<Entity, any, any, never>

execute

Parameters

optionalmethod: get | all | run

optionalmapResults: boolean

Returns Promise<Result>

inheritedfrom

Parameters

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

optionalaliasName: string

Returns SelectQueryBuilder<Entity, any, any, never>

inheritedgetCount

Parameters

optionalfield: EntityKeyOrString<Entity> | EntityKeyOrString<Entity>[]

optionaldistinct: boolean

Returns Promise<number>

inheritedgetFormattedQuery

Returns string

inheritedgetKnex

Parameters

processVirtualEntity: boolean = true