CountQueryBuilder <T>
Hierarchy
- QueryBuilder<T>
- CountQueryBuilder
Index
Accessors
Methods
- [custom]
- addSelect
- andWhere
- as
- cache
- clone
- count
- delete
- distinct
- distinctOn
- execute
- from
- getCount
- getFormattedQuery
- getKnex
- getKnexQuery
- getParams
- getQuery
- getResult
- getResultList
- getSingleResult
- groupBy
- having
- ignore
- indexHint
- insert
- join
- joinAndSelect
- leftJoin
- leftJoinAndSelect
- limit
- merge
- offset
- onConflict
- orWhere
- orderBy
- raw
- select
- setFlag
- setFlushMode
- setLockMode
- then
- truncate
- unsetFlag
- update
- where
- withSchema
- withSubQuery
Accessors
alias
Returns string
helper
Returns QueryBuilderHelper
mainAlias
Returns Alias
Methods
[custom]
Parameters
depth: number
Returns string
addSelect
Parameters
Returns SelectQueryBuilder<T>
andWhere
Parameters
cond: QBFilterQuery<T>
Returns CountQueryBuilder<T>
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 metadataParameters
alias: string
Returns QueryBuilder<any, any>
cache
Parameters
config: number | boolean | [string, number] = true
Returns CountQueryBuilder<T>
clone
Returns QueryBuilder<T>
count
Parameters
optionalfield: string | string[]
distinct: boolean = false
Returns CountQueryBuilder<T>
delete
Parameters
optionalcond: any
Returns DeleteQueryBuilder<T>
distinct
Returns SelectQueryBuilder<T>
distinctOn
postgres only
Parameters
fields: string | string[]
Returns SelectQueryBuilder<T>
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
- U = { count: number }[]
Parameters
optionalmethod: get | all | run
optionalmapResults: boolean
Returns Promise<U>
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
- T: Partial<T> = Partial<any>
Parameters
target: QueryBuilder<T>
optionalaliasName: string
Returns QueryBuilder<T>
getCount
Executes count query (without offset and limit), returning total count of results
Parameters
optionalfield: string | string[]
optionaldistinct: boolean
Returns Promise<number>
getFormattedQuery
Returns raw interpolated query string with all the parameters inlined.
Returns string
getKnex
Returns QueryBuilder<any, any>
getKnexQuery
Returns QueryBuilder<any, any>
getParams
Returns the list of all parameters for this query.
Returns readonly Value[]
getQuery
Returns the query with parameters as wildcards.
Returns string
getResult
Alias for
qb.getResultList()
Returns Promise<T[]>
getResultList
Executes the query, returning array of results
Returns Promise<T[]>
getSingleResult
Executes the query, returning the first result or null
Returns Promise<null | T>
groupBy
Parameters
fields: string | keyof T | readonly (string | keyof T)[]
Returns CountQueryBuilder<T>
having
Parameters
cond: any = {}
optionalparams: any[]
Returns CountQueryBuilder<T>
ignore
Returns CountQueryBuilder<T>
indexHint
Adds index hint to the FROM clause.
Parameters
sql: string
Returns CountQueryBuilder<T>
insert
Parameters
data: RequiredEntityData<T> | RequiredEntityData<T>[]
Returns InsertQueryBuilder<T>
join
Parameters
field: string
alias: string
cond: any = {}
type: leftJoin | innerJoin | pivotJoin = 'innerJoin'
optionalpath: string
Returns CountQueryBuilder<T>
joinAndSelect
Parameters
field: string
alias: string
cond: any = {}
type: leftJoin | innerJoin | pivotJoin = 'innerJoin'
optionalpath: string
Returns SelectQueryBuilder<T>
leftJoin
Parameters
field: string
alias: string
cond: any = {}
Returns CountQueryBuilder<T>
leftJoinAndSelect
Parameters
field: string
alias: string
cond: any = {}
Returns SelectQueryBuilder<T>
limit
Parameters
optionallimit: number
offset: number = 0
Returns CountQueryBuilder<T>
merge
Parameters
optionaldata: Field<T>[] | EntityData<T>
Returns CountQueryBuilder<T>
offset
Parameters
optionaloffset: number
Returns CountQueryBuilder<T>
onConflict
Parameters
Returns CountQueryBuilder<T>
orWhere
Parameters
cond: QBFilterQuery<T>
Returns CountQueryBuilder<T>
orderBy
Parameters
orderBy: QBQueryOrderMap<T> | QBQueryOrderMap<T>[]
Returns CountQueryBuilder<T>
raw
Type parameters
- R = Raw<any>
Parameters
sql: string
bindings: ValueDict | RawBinding[] = []
Returns R
select
Parameters
Returns SelectQueryBuilder<T>
setFlag
Parameters
flag: QueryFlag
Returns CountQueryBuilder<T>
setFlushMode
Parameters
optionalflushMode: FlushMode
Returns CountQueryBuilder<T>
setLockMode
Parameters
optionalmode: LockMode
optionaltables: string[]
Returns CountQueryBuilder<T>
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>
truncate
Returns TruncateQueryBuilder<T>
unsetFlag
Parameters
flag: QueryFlag
Returns CountQueryBuilder<T>
update
Parameters
data: EntityData<T>
Returns UpdateQueryBuilder<T>
where
Parameters
cond: QBFilterQuery<T>
optionaloperator: $and | $or
Returns CountQueryBuilder<T>
withSchema
Parameters
optionalschema: string
Returns CountQueryBuilder<T>
withSubQuery
Parameters
subQuery: QueryBuilder<any, any>
alias: string
Returns CountQueryBuilder<T>
SQL query builder with fluent interface.