Skip to main content

Version: 6.4

TruncateQueryBuilder <T>

Hierarchy

RunQueryBuilder<T>
- TruncateQueryBuilder

Properties

inheritedalias

alias: string

inheritedhelper

helper: QueryBuilderHelper

inheritedmainAlias

mainAlias: Alias<T>

Methods

inheritedaddSelect

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

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

inheritedandHaving

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

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

inheritedandWhere

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

Inherited from RunQueryBuilder.andWhere
Parameters
- cond: QBFilterQuery<T>
Returns this

inheritedapplyFilters

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

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

inheritedclone

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

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

inheritedcomment

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

Inherited from RunQueryBuilder.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<T> | EntityKeyOrString<T>[], distinct?: boolean): CountQueryBuilder<T>

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

inheriteddelete

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

Inherited from RunQueryBuilder.delete
Parameters
- optionalcond: QBFilterQuery
Returns DeleteQueryBuilder<T>

inheriteddistinct

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

Inherited from RunQueryBuilder.distinct
Returns SelectQueryBuilder<T, any, any, never>

inheriteddistinctOn

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

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

inheritedexecute

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

Inherited from RunQueryBuilder.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 RunQueryBuilder.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<T> | EntityKeyOrString<T>[], distinct?: boolean): Promise<number>

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

inheritedgetFormattedQuery

getFormattedQuery(): string

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

inheritedgetKnex

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

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

inheritedgetKnexQuery

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

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

inheritedgetLoggerContext

getLoggerContext(): T

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

inheritedgetParams

getParams(): readonly Value[]

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

inheritedgetQuery

getQuery(): string

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

inheritedgetResultAndCount

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

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

inheritedgroupBy

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

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

inheritedhasFlag

hasFlag(flag: QueryFlag): boolean

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

inheritedhaving

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

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

inheritedhintComment

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

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

inheritedindexHint

indexHint(sql: string): this

Inherited from RunQueryBuilder.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<T, any, any, { [ K in string ]: AddToContext<GetType<T, object, Field>, object, Field, Alias, false>[K] }>

Inherited from RunQueryBuilder.innerJoin
Parameters
- field: QueryBuilder<any, any> | QueryBuilder<any, never, never, never> | Field
- alias: Alias
- cond: QBFilterQuery = {}
- optionalschema: string
Returns SelectQueryBuilder<T, any, any, { [ K in string ]: AddToContext<GetType<T, 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<T, any, any, { [ K in string ]: AddToContext<GetType<T, object, Field>, object, Field, Alias, true>[K] }>

Inherited from RunQueryBuilder.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<T, any, any, { [ K in string ]: AddToContext<GetType<T, 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 RunQueryBuilder.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<T, any, any, { [ K in string ]: AddToContext<GetType<T, object, Field>, object, Field, Alias, true>[K] }>

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

inheritedinsert

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

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

inheritedjoin

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

Inherited from RunQueryBuilder.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<T, any, any, { [ K in string ]: AddToContext<GetType<T, 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<T, any, any, { [ K in string ]: AddToContext<GetType<T, object, Field>, object, Field, Alias, true>[K] }>

Inherited from RunQueryBuilder.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<T, any, any, { [ K in string ]: AddToContext<GetType<T, 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<T, any, any, { [ K in string ]: AddToContext<GetType<T, object, Field>, object, Field, Alias, false>[K] }>

Inherited from RunQueryBuilder.leftJoin
Parameters
- field: QueryBuilder<any, any> | QueryBuilder<any, never, never, never> | Field
- alias: Alias
- cond: QBFilterQuery = {}
- optionalschema: string
Returns SelectQueryBuilder<T, any, any, { [ K in string ]: AddToContext<GetType<T, 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<T, any, any, { [ K in string ]: AddToContext<GetType<T, object, Field>, object, Field, Alias, true>[K] }>

Inherited from RunQueryBuilder.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<T, any, any, { [ K in string ]: AddToContext<GetType<T, 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 RunQueryBuilder.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<T, any, any, { [ K in string ]: AddToContext<GetType<T, object, Field>, object, Field, Alias, true>[K] }>

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

inheritedlimit

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

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

inheritedmerge

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

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

inheritedoffset

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

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

inheritedonConflict

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

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

inheritedorderBy

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

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

inheritedorHaving

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

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

inheritedorWhere

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

Inherited from RunQueryBuilder.orWhere
Parameters
- cond: QBFilterQuery<T>
Returns this

inheritedreturning

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

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

inheritedselect

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

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

inheritedsetFlag

setFlag(flag: QueryFlag): this

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

inheritedsetFlushMode

setFlushMode(flushMode?: FlushMode): this

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

inheritedsetLockMode

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

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

inheritedsetLoggerContext

setLoggerContext(context: LoggingOptions & Dictionary): void

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

inheritedthen

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

Inherited from RunQueryBuilder.then
Provides promise-like interface so we can await the QB instance.
Parameters
- optionalonfulfilled: null | (value: QueryResult<T>) => TResult1 | PromiseLike<TResult1>
- optionalonrejected: null | (reason: any) => TResult2 | PromiseLike<TResult2>
Returns Promise<QueryResult<T>>

inheritedtoQuery

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

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

inheritedtruncate

truncate(): TruncateQueryBuilder<T>

Inherited from RunQueryBuilder.truncate
Returns TruncateQueryBuilder<T>

inheritedunsetFlag

unsetFlag(flag: QueryFlag): this

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

inheritedupdate

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

Inherited from RunQueryBuilder.update
Parameters
- data: EntityData<T>
Returns UpdateQueryBuilder<T>

inheritedwhere

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

Inherited from RunQueryBuilder.where
Parameters
- cond: string | QBFilterQuery<T>
- optionalparams: any[] | $and | $or
- optionaloperator: $and | $or
Returns this

inheritedwithSchema

withSchema(schema?: string): this

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

inheritedwithSubQuery

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

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