Class: QueryBuilder<T>#
knex.QueryBuilder
SQL query builder
Type parameters#
| Name | Type | Default |
|---|---|---|
T | AnyEntity<T> | AnyEntity |
Constructors#
constructor#
+ new QueryBuilder<T>(entityName: string, metadata: MetadataStorage, driver: AbstractSqlDriver<AbstractSqlConnection>, context?: Transaction<any, any>, alias?: string, connectionType?: read | write, em?: EntityManager<AbstractSqlDriver<AbstractSqlConnection>>): QueryBuilder<T>
Type parameters:#
| Name | Type | Default |
|---|---|---|
T | AnyEntity<T> | AnyEntity<any> |
Parameters:#
| Name | Type |
|---|---|
entityName | string |
metadata | MetadataStorage |
driver | AbstractSqlDriver<AbstractSqlConnection> |
context? | Transaction<any, any> |
alias | string |
connectionType? | read | write |
em? | EntityManager<AbstractSqlDriver<AbstractSqlConnection>> |
Returns: QueryBuilder<T>
Defined in: packages/knex/src/query/QueryBuilder.ts:59
Properties#
_aliasMap#
• Private _aliasMap: Dictionary<string>
Defined in: packages/knex/src/query/QueryBuilder.ts:43
_cache#
• Private Optional _cache: number | boolean | [string, number]
Defined in: packages/knex/src/query/QueryBuilder.ts:54
_cond#
• Private _cond: Dictionary<any>
Defined in: packages/knex/src/query/QueryBuilder.ts:45
_data#
• Private _data: Dictionary<any>
Defined in: packages/knex/src/query/QueryBuilder.ts:46
_fields#
• Optional _fields: Field<T>[]
Defined in: packages/knex/src/query/QueryBuilder.ts:35
_groupBy#
• Private _groupBy: Field<T>[]
Defined in: packages/knex/src/query/QueryBuilder.ts:48
_having#
• Private _having: Dictionary<any>
Defined in: packages/knex/src/query/QueryBuilder.ts:49
_joinedProps#
• Private _joinedProps: Map<string, PopulateOptions<any>>
Defined in: packages/knex/src/query/QueryBuilder.ts:53
_joins#
• Private _joins: Dictionary<JoinOptions>
Defined in: packages/knex/src/query/QueryBuilder.ts:42
_limit#
• Private Optional _limit: number
Defined in: packages/knex/src/query/QueryBuilder.ts:51
_offset#
• Private Optional _offset: number
Defined in: packages/knex/src/query/QueryBuilder.ts:52
_onConflict#
• Private Optional _onConflict: { fields: string[] ; ignore?: boolean ; merge?: EntityData<T> ; where?: FilterQuery<T> | FilterQuery<T> & Dictionary<any> }[]
Defined in: packages/knex/src/query/QueryBuilder.ts:50
_orderBy#
• Private _orderBy: QueryOrderMap
Defined in: packages/knex/src/query/QueryBuilder.ts:47
_populate#
• _populate: PopulateOptions<T>[]
Defined in: packages/knex/src/query/QueryBuilder.ts:36
_populateMap#
• _populateMap: Dictionary<string>
Defined in: packages/knex/src/query/QueryBuilder.ts:37
_schema#
• Private Optional _schema: string
Defined in: packages/knex/src/query/QueryBuilder.ts:44
alias#
• Readonly alias: string
aliasCounter#
• Private aliasCounter: number= 1
Defined in: packages/knex/src/query/QueryBuilder.ts:39
finalized#
• Private finalized: boolean= false
Defined in: packages/knex/src/query/QueryBuilder.ts:41
flags#
• Private flags: Set<QueryFlag>
Defined in: packages/knex/src/query/QueryBuilder.ts:40
helper#
• Private Readonly helper: QueryBuilderHelper
Defined in: packages/knex/src/query/QueryBuilder.ts:59
knex#
• Private Readonly knex: Knex<any, unknown[]>
Defined in: packages/knex/src/query/QueryBuilder.ts:58
lockMode#
• Private Optional lockMode: LockMode
Defined in: packages/knex/src/query/QueryBuilder.ts:55
platform#
• Private Readonly platform: AbstractSqlPlatform
Defined in: packages/knex/src/query/QueryBuilder.ts:57
subQueries#
• Private subQueries: Dictionary<string>
Defined in: packages/knex/src/query/QueryBuilder.ts:56
type#
• type: QueryType
Defined in: packages/knex/src/query/QueryBuilder.ts:34
Methods#
addSelect#
â–¸ addSelect(fields: Field<T> | Field<T>[]): QueryBuilder<T>
Parameters:#
| Name | Type |
|---|---|
fields | Field<T> | Field<T>[] |
Returns: QueryBuilder<T>
Defined in: packages/knex/src/query/QueryBuilder.ts:81
andWhere#
â–¸ andWhere(cond: FilterQuery<T> | FilterQuery<T> & Dictionary<any>): QueryBuilder<T>
Parameters:#
| Name | Type |
|---|---|
cond | FilterQuery<T> | FilterQuery<T> & Dictionary<any> |
Returns: QueryBuilder<T>
Defined in: packages/knex/src/query/QueryBuilder.ts:197
â–¸ andWhere(cond: string, params?: any[]): QueryBuilder<T>
Parameters:#
| Name | Type |
|---|---|
cond | string |
params? | any[] |
Returns: QueryBuilder<T>
Defined in: packages/knex/src/query/QueryBuilder.ts:198
as#
â–¸ as(alias: string): QueryBuilder<any, any>
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:#
| Name | Type |
|---|---|
alias | string |
Returns: QueryBuilder<any, any>
Defined in: packages/knex/src/query/QueryBuilder.ts:459
autoJoinPivotTable#
â–¸ PrivateautoJoinPivotTable(field: string): void
Parameters:#
| Name | Type |
|---|---|
field | string |
Returns: void
Defined in: packages/knex/src/query/QueryBuilder.ts:721
cache#
â–¸ cache(config?: number | boolean | [string, number]): QueryBuilder<T>
Parameters:#
| Name | Type | Default value |
|---|---|---|
config | number | boolean | [string, number] | true |
Returns: QueryBuilder<T>
Defined in: packages/knex/src/query/QueryBuilder.ts:309
clone#
â–¸ clone(): QueryBuilder<T>
Returns: QueryBuilder<T>
Defined in: packages/knex/src/query/QueryBuilder.ts:472
count#
â–¸ count(field?: string | string[], distinct?: boolean): QueryBuilder<T>
Parameters:#
| Name | Type | Default value |
|---|---|---|
field? | string | string[] | - |
distinct | boolean | false |
Returns: QueryBuilder<T>
Defined in: packages/knex/src/query/QueryBuilder.ts:105
delete#
â–¸ delete(cond?: any): QueryBuilder<T>
Parameters:#
| Name | Type |
|---|---|
cond | any |
Returns: QueryBuilder<T>
Defined in: packages/knex/src/query/QueryBuilder.ts:97
execute#
â–¸ execute<U>(method?: all | get | run, mapResults?: boolean): Promise<U>
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:#
| Name | Default |
|---|---|
U | any |
Parameters:#
| Name | Type | Default value |
|---|---|---|
method | all | get | run | 'all' |
mapResults | boolean | true |
Returns: Promise<U>
Defined in: packages/knex/src/query/QueryBuilder.ts:391
finalize#
â–¸ Privatefinalize(): void
Returns: void
Defined in: packages/knex/src/query/QueryBuilder.ts:634
getAliasForJoinPath#
â–¸ getAliasForJoinPath(path?: string): undefined | string
Parameters:#
| Name | Type |
|---|---|
path? | string |
Returns: undefined | string
Defined in: packages/knex/src/query/QueryBuilder.ts:367
getFieldsForJoinedLoad#
â–¸ ProtectedgetFieldsForJoinedLoad<U>(prop: EntityProperty<U>, alias: string): Field<U>[]
Type parameters:#
| Name | Type |
|---|---|
U | AnyEntity<U> |
Parameters:#
| Name | Type |
|---|---|
prop | EntityProperty<U> |
alias | string |
Returns: Field<U>[]
Defined in: packages/knex/src/query/QueryBuilder.ts:146
getFormattedQuery#
â–¸ getFormattedQuery(): string
Returns raw interpolated query string with all the parameters inlined.
Returns: string
Defined in: packages/knex/src/query/QueryBuilder.ts:362
getKnex#
â–¸ getKnex(): QueryBuilder<any, any>
Returns: QueryBuilder<any, any>
Defined in: packages/knex/src/query/QueryBuilder.ts:484
getKnexQuery#
â–¸ getKnexQuery(): QueryBuilder<any, any>
Returns: QueryBuilder<any, any>
Defined in: packages/knex/src/query/QueryBuilder.ts:314
getNextAlias#
â–¸ getNextAlias(prefix?: string): string
Parameters:#
| Name | Type | Default value |
|---|---|---|
prefix | string | 'e' |
Returns: string
Defined in: packages/knex/src/query/QueryBuilder.ts:382
getParams#
â–¸ getParams(): readonly Value[]
Returns the list of all parameters for this query.
Returns: readonly Value[]
Defined in: packages/knex/src/query/QueryBuilder.ts:355
getQuery#
â–¸ getQuery(): string
Returns the query with parameters as wildcards.
Returns: string
Defined in: packages/knex/src/query/QueryBuilder.ts:348
getQueryBase#
â–¸ PrivategetQueryBase(): QueryBuilder<any, any>
Returns: QueryBuilder<any, any>
Defined in: packages/knex/src/query/QueryBuilder.ts:593
getResult#
â–¸ getResult(): Promise<T[]>
Alias for qb.getResultList()
Returns: Promise<T[]>
Defined in: packages/knex/src/query/QueryBuilder.ts:430
getResultList#
â–¸ getResultList(): Promise<T[]>
Executes the query, returning array of results
Returns: Promise<T[]>
Defined in: packages/knex/src/query/QueryBuilder.ts:437
getSingleResult#
â–¸ getSingleResult(): Promise<null | T>
Executes the query, returning the first result or null
Returns: Promise<null | T>
Defined in: packages/knex/src/query/QueryBuilder.ts:450
groupBy#
â–¸ groupBy(fields: string | keyof T | (string | keyof T)[]): QueryBuilder<T>
Parameters:#
| Name | Type |
|---|---|
fields | string | keyof T | (string | keyof T)[] |
Returns: QueryBuilder<T>
Defined in: packages/knex/src/query/QueryBuilder.ts:215
having#
â–¸ having(cond?: any, params?: any[]): QueryBuilder<T>
Parameters:#
| Name | Type |
|---|---|
cond | any |
params? | any[] |
Returns: QueryBuilder<T>
Defined in: packages/knex/src/query/QueryBuilder.ts:220
ignore#
â–¸ ignore(): QueryBuilder<T>
Returns: QueryBuilder<T>
Defined in: packages/knex/src/query/QueryBuilder.ts:235
init#
â–¸ Privateinit(type: QueryType, data?: any, cond?: any): QueryBuilder<T>
Parameters:#
| Name | Type |
|---|---|
type | QueryType |
data? | any |
cond? | any |
Returns: QueryBuilder<T>
Defined in: packages/knex/src/query/QueryBuilder.ts:574
insert#
â–¸ insert(data: EntityData<T>): QueryBuilder<T>
Parameters:#
| Name | Type |
|---|---|
data | EntityData<T> |
Returns: QueryBuilder<T>
Defined in: packages/knex/src/query/QueryBuilder.ts:89
join#
â–¸ join(field: string, alias: string, cond?: any, type?: leftJoin | innerJoin | pivotJoin, path?: string): QueryBuilder<T>
Parameters:#
| Name | Type | Default value |
|---|---|---|
field | string | - |
alias | string | - |
cond | any | - |
type | leftJoin | innerJoin | pivotJoin | 'innerJoin' |
path? | string | - |
Returns: QueryBuilder<T>
Defined in: packages/knex/src/query/QueryBuilder.ts:115
joinAndSelect#
â–¸ joinAndSelect(field: string, alias: string, cond?: any, type?: leftJoin | innerJoin | pivotJoin, path?: string): QueryBuilder<T>
Parameters:#
| Name | Type | Default value |
|---|---|---|
field | string | - |
alias | string | - |
cond | any | - |
type | leftJoin | innerJoin | pivotJoin | 'innerJoin' |
path? | string | - |
Returns: QueryBuilder<T>
Defined in: packages/knex/src/query/QueryBuilder.ts:124
joinReference#
â–¸ PrivatejoinReference(field: string, alias: string, cond: Dictionary<any>, type: leftJoin | innerJoin | pivotJoin, path?: string): EntityProperty<any>
Parameters:#
| Name | Type |
|---|---|
field | string |
alias | string |
cond | Dictionary<any> |
type | leftJoin | innerJoin | pivotJoin |
path? | string |
Returns: EntityProperty<any>
Defined in: packages/knex/src/query/QueryBuilder.ts:495
leftJoin#
â–¸ leftJoin(field: string, alias: string, cond?: any): QueryBuilder<T>
Parameters:#
| Name | Type |
|---|---|
field | string |
alias | string |
cond | any |
Returns: QueryBuilder<T>
Defined in: packages/knex/src/query/QueryBuilder.ts:120
leftJoinAndSelect#
â–¸ leftJoinAndSelect(field: string, alias: string, cond?: any): QueryBuilder<T>
Parameters:#
| Name | Type |
|---|---|
field | string |
alias | string |
cond | any |
Returns: QueryBuilder<T>
Defined in: packages/knex/src/query/QueryBuilder.ts:142
limit#
â–¸ limit(limit?: number, offset?: number): QueryBuilder<T>
Parameters:#
| Name | Type | Default value |
|---|---|---|
limit? | number | - |
offset | number | 0 |
Returns: QueryBuilder<T>
Defined in: packages/knex/src/query/QueryBuilder.ts:268
merge#
â–¸ merge(data?: EntityData<T>): QueryBuilder<T>
Parameters:#
| Name | Type |
|---|---|
data? | EntityData<T> |
Returns: QueryBuilder<T>
Defined in: packages/knex/src/query/QueryBuilder.ts:240
offset#
â–¸ offset(offset?: number): QueryBuilder<T>
Parameters:#
| Name | Type |
|---|---|
offset? | number |
Returns: QueryBuilder<T>
Defined in: packages/knex/src/query/QueryBuilder.ts:278
onConflict#
â–¸ onConflict(fields: string | string[]): QueryBuilder<T>
Parameters:#
| Name | Type |
|---|---|
fields | string | string[] |
Returns: QueryBuilder<T>
Defined in: packages/knex/src/query/QueryBuilder.ts:229
orWhere#
â–¸ orWhere(cond: FilterQuery<T> | FilterQuery<T> & Dictionary<any>): QueryBuilder<T>
Parameters:#
| Name | Type |
|---|---|
cond | FilterQuery<T> | FilterQuery<T> & Dictionary<any> |
Returns: QueryBuilder<T>
Defined in: packages/knex/src/query/QueryBuilder.ts:203
â–¸ orWhere(cond: string, params?: any[]): QueryBuilder<T>
Parameters:#
| Name | Type |
|---|---|
cond | string |
params? | any[] |
Returns: QueryBuilder<T>
Defined in: packages/knex/src/query/QueryBuilder.ts:204
orderBy#
â–¸ orderBy(orderBy: QueryOrderMap): QueryBuilder<T>
Parameters:#
| Name | Type |
|---|---|
orderBy | QueryOrderMap |
Returns: QueryBuilder<T>
Defined in: packages/knex/src/query/QueryBuilder.ts:209
populate#
â–¸ populate(populate: PopulateOptions<T>[]): QueryBuilder<T>
internal
Parameters:#
| Name | Type |
|---|---|
populate | PopulateOptions<T>[] |
Returns: QueryBuilder<T>
Defined in: packages/knex/src/query/QueryBuilder.ts:248
prepareFields#
â–¸ PrivateprepareFields<T, U>(fields: Field<T>[], type?: groupBy | where | sub-query): U[]
Type parameters:#
| Name | Type | Default |
|---|---|---|
T | AnyEntity<T> | - |
U | string | Raw<any> | string | Raw<any> |
Parameters:#
| Name | Type | Default value |
|---|---|---|
fields | Field<T>[] | - |
type | groupBy | where | sub-query | 'where' |
Returns: U[]
Defined in: packages/knex/src/query/QueryBuilder.ts:536
raw#
â–¸ raw(sql: string): Raw<any>
Parameters:#
| Name | Type |
|---|---|
sql | string |
Returns: Raw<any>
Defined in: packages/knex/src/query/QueryBuilder.ts:261
ref#
â–¸ ref(field: string): Ref<string, {}>
internal
Parameters:#
| Name | Type |
|---|---|
field | string |
Returns: Ref<string, {}>
Defined in: packages/knex/src/query/QueryBuilder.ts:257
select#
â–¸ select(fields: Field<T> | Field<T>[], distinct?: boolean): QueryBuilder<T>
Parameters:#
| Name | Type | Default value |
|---|---|---|
fields | Field<T> | Field<T>[] | - |
distinct | boolean | false |
Returns: QueryBuilder<T>
Defined in: packages/knex/src/query/QueryBuilder.ts:71
setFlag#
â–¸ setFlag(flag: QueryFlag): QueryBuilder<T>
Parameters:#
| Name | Type |
|---|---|
flag | QueryFlag |
Returns: QueryBuilder<T>
Defined in: packages/knex/src/query/QueryBuilder.ts:299
setLockMode#
â–¸ setLockMode(mode?: LockMode): QueryBuilder<T>
Parameters:#
| Name | Type |
|---|---|
mode? | LockMode |
Returns: QueryBuilder<T>
Defined in: packages/knex/src/query/QueryBuilder.ts:289
truncate#
â–¸ truncate(): QueryBuilder<T>
Returns: QueryBuilder<T>
Defined in: packages/knex/src/query/QueryBuilder.ts:101
unsetFlag#
â–¸ unsetFlag(flag: QueryFlag): QueryBuilder<T>
Parameters:#
| Name | Type |
|---|---|
flag | QueryFlag |
Returns: QueryBuilder<T>
Defined in: packages/knex/src/query/QueryBuilder.ts:304
update#
â–¸ update(data: EntityData<T>): QueryBuilder<T>
Parameters:#
| Name | Type |
|---|---|
data | EntityData<T> |
Returns: QueryBuilder<T>
Defined in: packages/knex/src/query/QueryBuilder.ts:93
where#
â–¸ where(cond: FilterQuery<T> | FilterQuery<T> & Dictionary<any>, operator?: $and | $or): QueryBuilder<T>
Parameters:#
| Name | Type |
|---|---|
cond | FilterQuery<T> | FilterQuery<T> & Dictionary<any> |
operator? | $and | $or |
Returns: QueryBuilder<T>
Defined in: packages/knex/src/query/QueryBuilder.ts:160
â–¸ where(cond: string, params?: any[], operator?: $and | $or): QueryBuilder<T>
Parameters:#
| Name | Type |
|---|---|
cond | string |
params? | any[] |
operator? | $and | $or |
Returns: QueryBuilder<T>
Defined in: packages/knex/src/query/QueryBuilder.ts:161
withSchema#
â–¸ withSchema(schema?: string): QueryBuilder<T>
Parameters:#
| Name | Type |
|---|---|
schema? | string |
Returns: QueryBuilder<T>
Defined in: packages/knex/src/query/QueryBuilder.ts:283
withSubQuery#
â–¸ withSubQuery(subQuery: QueryBuilder<any, any>, alias: string): QueryBuilder<T>
Parameters:#
| Name | Type |
|---|---|
subQuery | QueryBuilder<any, any> |
alias | string |
Returns: QueryBuilder<T>
Defined in: packages/knex/src/query/QueryBuilder.ts:155
wrapModifySubQuery#
â–¸ PrivatewrapModifySubQuery(meta: EntityMetadata<any>): void
Parameters:#
| Name | Type |
|---|---|
meta | EntityMetadata<any> |
Returns: void
Defined in: packages/knex/src/query/QueryBuilder.ts:707
wrapPaginateSubQuery#
â–¸ PrivatewrapPaginateSubQuery(meta: EntityMetadata<any>): void
Parameters:#
| Name | Type |
|---|---|
meta | EntityMetadata<any> |
Returns: void
Defined in: packages/knex/src/query/QueryBuilder.ts:687