Skip to main content

Version: 5.7

TruncateQueryBuilder <T>

Hierarchy

RunQueryBuilder<T>
- TruncateQueryBuilder

Properties

alias

alias: string

helper

helper: QueryBuilderHelper

mainAlias

mainAlias: Alias

Methods

[custom]

[custom](depth: number): string

Inherited from RunQueryBuilder.[custom]
Parameters
- depth: number
Returns string

addSelect

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

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

andWhere

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

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

as

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>

cache

cache(config?: number | boolean | [string, number]): QueryBuilder<T>

Inherited from RunQueryBuilder.cache
Parameters
- config: number | boolean | [string, number] = true
Returns QueryBuilder<T>

clone

clone(): QueryBuilder<T>

Inherited from RunQueryBuilder.clone
Returns QueryBuilder<T>

count

count(field?: string | string[], distinct?: boolean): CountQueryBuilder<T>

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

delete

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

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

distinct

distinct(): SelectQueryBuilder<T>

Inherited from RunQueryBuilder.distinct
Returns SelectQueryBuilder<T>

distinctOn

distinctOn(fields: string | string[]): SelectQueryBuilder<T>

Inherited from RunQueryBuilder.distinctOn
postgres only
Parameters
- fields: string | string[]
Returns SelectQueryBuilder<T>

execute

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

Inherited from RunQueryBuilder.execute
Type parameters
- U = QueryResult<T>
Parameters
- optionalmethod: get | all | run
- optionalmapResults: boolean
Returns Promise<U>

from

from<T>(target: QueryBuilder<T>, aliasName?: string): QueryBuilder<T>
from<T>(target: EntityName<T>): QueryBuilder<T>

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.
Type parameters
- T: Partial<T> = Partial<any>
Parameters
- target: QueryBuilder<T>
- optionalaliasName: string
Returns QueryBuilder<T>

getCount

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

Inherited from RunQueryBuilder.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 RunQueryBuilder.getFormattedQuery
Returns raw interpolated query string with all the parameters inlined.
Returns string

getKnex

getKnex(): QueryBuilder<any, any>

Inherited from RunQueryBuilder.getKnex
Returns QueryBuilder<any, any>

getKnexQuery

getKnexQuery(): QueryBuilder<any, any>

Inherited from RunQueryBuilder.getKnexQuery
Returns QueryBuilder<any, any>

getParams

getParams(): readonly Value[]

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

getQuery

getQuery(): string

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

getResultAndCount

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

groupBy

groupBy(fields: string | keyof T | readonly (string | keyof T)[]): QueryBuilder<T>

Inherited from RunQueryBuilder.groupBy
Parameters
- fields: string | keyof T | readonly (string | keyof T)[]
Returns QueryBuilder<T>

having

having(cond?: string | QBFilterQuery, params?: any[]): QueryBuilder<T>

Inherited from RunQueryBuilder.having
Parameters
- cond: string | QBFilterQuery = {}
- optionalparams: any[]
Returns QueryBuilder<T>

ignore

ignore(): QueryBuilder<T>

Inherited from RunQueryBuilder.ignore
Returns QueryBuilder<T>

indexHint

indexHint(sql: string): QueryBuilder<T>

Inherited from RunQueryBuilder.indexHint
Adds index hint to the FROM clause.
Parameters
- sql: string
Returns QueryBuilder<T>

insert

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

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

join

join(field: string, alias: string, cond?: QBFilterQuery, type?: leftJoin | innerJoin | pivotJoin, path?: string): QueryBuilder<T>

Inherited from RunQueryBuilder.join
Parameters
- field: string
- alias: string
- cond: QBFilterQuery = {}
- type: leftJoin | innerJoin | pivotJoin = 'innerJoin'
- optionalpath: string
Returns QueryBuilder<T>

joinAndSelect

joinAndSelect(field: string, alias: string, cond?: QBFilterQuery, type?: leftJoin | innerJoin | pivotJoin, path?: string): SelectQueryBuilder<T>

Inherited from RunQueryBuilder.joinAndSelect
Parameters
- field: string
- alias: string
- cond: QBFilterQuery = {}
- type: leftJoin | innerJoin | pivotJoin = 'innerJoin'
- optionalpath: string
Returns SelectQueryBuilder<T>

leftJoin

leftJoin(field: string, alias: string, cond?: QBFilterQuery): QueryBuilder<T>

Inherited from RunQueryBuilder.leftJoin
Parameters
- field: string
- alias: string
- cond: QBFilterQuery = {}
Returns QueryBuilder<T>

leftJoinAndSelect

leftJoinAndSelect(field: string, alias: string, cond?: QBFilterQuery): SelectQueryBuilder<T>

Inherited from RunQueryBuilder.leftJoinAndSelect
Parameters
- field: string
- alias: string
- cond: QBFilterQuery = {}
Returns SelectQueryBuilder<T>

limit

limit(limit?: number, offset?: number): QueryBuilder<T>

Inherited from RunQueryBuilder.limit
Parameters
- optionallimit: number
- offset: number = 0
Returns QueryBuilder<T>

merge

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

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

offset

offset(offset?: number): QueryBuilder<T>

Inherited from RunQueryBuilder.offset
Parameters
- optionaloffset: number
Returns QueryBuilder<T>

onConflict

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

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

orWhere

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

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

orderBy

orderBy(orderBy: QBQueryOrderMap<T> | QBQueryOrderMap<T>[]): QueryBuilder<T>

Inherited from RunQueryBuilder.orderBy
Parameters
- orderBy: QBQueryOrderMap<T> | QBQueryOrderMap<T>[]
Returns QueryBuilder<T>

raw

raw<R>(sql: string, bindings?: ValueDict | RawBinding[]): R

Inherited from RunQueryBuilder.raw
Type parameters
- R = Raw<any>
Parameters
- sql: string
- bindings: ValueDict | RawBinding[] = []
Returns R

select

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

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

setFlag

setFlag(flag: QueryFlag): QueryBuilder<T>

Inherited from RunQueryBuilder.setFlag
Parameters
- flag: QueryFlag
Returns QueryBuilder<T>

setFlushMode

setFlushMode(flushMode?: FlushMode): QueryBuilder<T>

Inherited from RunQueryBuilder.setFlushMode
Parameters
- optionalflushMode: FlushMode
Returns QueryBuilder<T>

setLockMode

setLockMode(mode?: LockMode, tables?: string[]): QueryBuilder<T>

Inherited from RunQueryBuilder.setLockMode
Parameters
- optionalmode: LockMode
- optionaltables: string[]
Returns QueryBuilder<T>

then

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

Inherited from RunQueryBuilder.then
Type parameters
- TResult1 = QueryResult<T>
- TResult2 = never
Parameters
- optionalonfulfilled: null | (value: QueryResult<T>) => TResult1 | PromiseLike<TResult1>
- optionalonrejected: null | (reason: any) => TResult2 | PromiseLike<TResult2>
Returns Promise<QueryResult<T>>

truncate

truncate(): TruncateQueryBuilder<T>

Inherited from RunQueryBuilder.truncate
Returns TruncateQueryBuilder<T>

unsetFlag

unsetFlag(flag: QueryFlag): QueryBuilder<T>

Inherited from RunQueryBuilder.unsetFlag
Parameters
- flag: QueryFlag
Returns QueryBuilder<T>

update

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

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

where

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

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

withSchema

withSchema(schema?: string): QueryBuilder<T>

Inherited from RunQueryBuilder.withSchema
Parameters
- optionalschema: string
Returns QueryBuilder<T>

withSubQuery

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

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