Skip to main content
Version: 6.1

TruncateQueryBuilder <T>

Hierarchy

Index

Properties

alias

alias: string

helper

helper: QueryBuilderHelper

mainAlias

mainAlias: Alias<T>

Methods

addSelect

andWhere

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

    • alias: string

    Returns QueryBuilder<any, any>

cache

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

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

    Returns QueryBuilder<T>

clone

  • Parameters

    • optionalreset: boolean | string[]

    Returns QueryBuilder<T>

comment

  • Prepend comment to the sql query using the syntax /* ... *&#8205;/. Some characters are forbidden such as /*, *&#8205;/ and ?.


    Parameters

    • comment: string | string[]

    Returns QueryBuilder<T>

count

  • Parameters

    • optionalfield: string | string[]
    • distinct: boolean = false

    Returns CountQueryBuilder<T>

delete

distinct

distinctOn

  • postgres only


    Parameters

    • fields: string | string[]

    Returns SelectQueryBuilder<T>

execute

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

    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

    Returns SelectQueryBuilder<T>

getCount

  • getCount(field?: string | string[], distinct?: boolean): Promise<number>
  • Executes count query (without offset and limit), returning total count of results


    Parameters

    • optionalfield: string | string[]
    • optionaldistinct: boolean

    Returns Promise<number>

getFormattedQuery

  • getFormattedQuery(): string
  • Returns raw interpolated query string with all the parameters inlined.


    Returns string

getKnex

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

    • processVirtualEntity: boolean = true

    Returns QueryBuilder<any, any>

getKnexQuery

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

    • processVirtualEntity: boolean = true

    Returns QueryBuilder<any, any>

getParams

  • getParams(): readonly Value[]
  • Returns the list of all parameters for this query.


    Returns readonly Value[]

getQuery

  • getQuery(): string
  • Returns the query with parameters as wildcards.


    Returns string

getResultAndCount

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


    Returns Promise<[T[], number]>

groupBy

  • Parameters

    • fields: string | keyof T | readonly (string | keyof T)[]

    Returns SelectQueryBuilder<T>

hasFlag

  • Parameters

    Returns boolean

having

hintComment

  • Add hints to the query using comment-like syntax /*+ ... *&#8205;/. 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 QueryBuilder<T>

ignore

  • Returns QueryBuilder<T>

indexHint

  • Adds index hint to the FROM clause.


    Parameters

    • sql: string

    Returns QueryBuilder<T>

innerJoin

  • Parameters

    Returns QueryBuilder<T>

innerJoinAndSelect

  • Parameters

    • field: string | [field: string, qb: QueryBuilder<any, any> | QueryBuilder<any>]
    • alias: string
    • cond: QBFilterQuery = {}
    • optionalfields: string[]
    • optionalschema: string

    Returns SelectQueryBuilder<T>

innerJoinLateral

  • Parameters

    Returns QueryBuilder<T>

innerJoinLateralAndSelect

  • Parameters

    • field: string | [field: string, qb: QueryBuilder<any, any> | QueryBuilder<any>]
    • alias: string
    • cond: QBFilterQuery = {}
    • optionalfields: string[]
    • optionalschema: string

    Returns SelectQueryBuilder<T>

insert

join

  • Parameters

    • field: string | QueryBuilder<any, any> | QueryBuilder<any>
    • alias: string
    • cond: QBFilterQuery = {}
    • type: JoinType = JoinType.innerJoin
    • optionalpath: string
    • optionalschema: string

    Returns QueryBuilder<T>

joinAndSelect

  • Parameters

    • field: string | [field: string, qb: QueryBuilder<any, any> | QueryBuilder<any>]
    • alias: string
    • cond: QBFilterQuery = {}
    • type: JoinType = JoinType.innerJoin
    • optionalpath: string
    • optionalfields: string[]
    • optionalschema: string

    Returns SelectQueryBuilder<T>

leftJoin

  • Parameters

    Returns QueryBuilder<T>

leftJoinAndSelect

  • Parameters

    • field: string | [field: string, qb: QueryBuilder<any, any> | QueryBuilder<any>]
    • alias: string
    • cond: QBFilterQuery = {}
    • optionalfields: string[]
    • optionalschema: string

    Returns SelectQueryBuilder<T>

leftJoinLateral

  • Parameters

    Returns QueryBuilder<T>

leftJoinLateralAndSelect

  • Parameters

    • field: string | [field: string, qb: QueryBuilder<any, any> | QueryBuilder<any>]
    • alias: string
    • cond: QBFilterQuery = {}
    • optionalfields: string[]
    • optionalschema: string

    Returns SelectQueryBuilder<T>

limit

  • Parameters

    • optionallimit: number
    • offset: number = 0

    Returns SelectQueryBuilder<T>

merge

offset

  • Parameters

    • optionaloffset: number

    Returns SelectQueryBuilder<T>

onConflict

orWhere

orderBy

returning

  • Parameters

    Returns QueryBuilder<T>

select

setFlag

setFlushMode

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>>
  • Type parameters

    Parameters

    • optionalonfulfilled: null | (value: QueryResult<T>) => TResult1 | PromiseLike<TResult1>
    • optionalonrejected: null | (reason: any) => TResult2 | PromiseLike<TResult2>

    Returns Promise<QueryResult<T>>

toQuery

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

    • _sql: Sql
    • params: readonly unknown[]
    • sql: string

truncate

unsetFlag

update

where

  • Parameters

    • cond: string | QBFilterQuery<T>
    • optionalparams: any[] | $and | $or
    • optionaloperator: $and | $or

    Returns TruncateQueryBuilder<T>

withSchema

  • Parameters

    • optionalschema: string

    Returns QueryBuilder<T>

withSubQuery

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

    • subQuery: QueryBuilder<any, any>
    • alias: string

    Returns QueryBuilder<T>