TruncateQueryBuilder <T>
Hierarchy
- RunQueryBuilder<T>
- TruncateQueryBuilder
Index
Properties
Methods
- [custom]
- addSelect
- andWhere
- as
- cache
- clone
- count
- delete
- distinct
- distinctOn
- execute
- from
- getCount
- getFormattedQuery
- getKnex
- getKnexQuery
- getParams
- getQuery
- getResultAndCount
- 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
Properties
alias
helper
mainAlias
Methods
[custom]
Parameters
depth: number
Returns string
addSelect
Parameters
Returns SelectQueryBuilder<T>
andWhere
Parameters
cond: QBFilterQuery<T>
Returns QueryBuilder<T>
as
Parameters
alias: string
Returns QueryBuilder<any, any>
cache
Parameters
config: number | boolean | [string, number] = true
Returns QueryBuilder<T>
clone
Returns QueryBuilder<T>
count
Parameters
optionalfield: string | string[]
distinct: boolean = false
Returns CountQueryBuilder<T>
delete
Parameters
optionalcond: QBFilterQuery
Returns DeleteQueryBuilder<T>
distinct
Returns SelectQueryBuilder<T>
distinctOn
postgres only
Parameters
fields: string | string[]
Returns SelectQueryBuilder<T>
execute
Type parameters
- U = QueryResult<T>
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
getResultAndCount
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 QueryBuilder<T>
having
Parameters
cond: string | QBFilterQuery = {}
optionalparams: any[]
Returns QueryBuilder<T>
ignore
Returns QueryBuilder<T>
indexHint
Adds index hint to the FROM clause.
Parameters
sql: string
Returns QueryBuilder<T>
insert
Parameters
data: RequiredEntityData<T> | RequiredEntityData<T>[]
Returns InsertQueryBuilder<T>
join
Parameters
field: string
alias: string
cond: QBFilterQuery = {}
type: leftJoin | innerJoin | pivotJoin = 'innerJoin'
optionalpath: string
Returns QueryBuilder<T>
joinAndSelect
Parameters
field: string
alias: string
cond: QBFilterQuery = {}
type: leftJoin | innerJoin | pivotJoin = 'innerJoin'
optionalpath: string
Returns SelectQueryBuilder<T>
leftJoin
Parameters
field: string
alias: string
cond: QBFilterQuery = {}
Returns QueryBuilder<T>
leftJoinAndSelect
Parameters
field: string
alias: string
cond: QBFilterQuery = {}
Returns SelectQueryBuilder<T>
limit
Parameters
optionallimit: number
offset: number = 0
Returns QueryBuilder<T>
merge
Parameters
optionaldata: Field<T>[] | EntityData<T>
Returns QueryBuilder<T>
offset
Parameters
optionaloffset: number
Returns QueryBuilder<T>
onConflict
Parameters
Returns QueryBuilder<T>
orWhere
Parameters
cond: QBFilterQuery<T>
Returns QueryBuilder<T>
orderBy
Parameters
orderBy: QBQueryOrderMap<T> | QBQueryOrderMap<T>[]
Returns QueryBuilder<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 QueryBuilder<T>
setFlushMode
Parameters
optionalflushMode: FlushMode
Returns QueryBuilder<T>
setLockMode
Parameters
optionalmode: LockMode
optionaltables: string[]
Returns QueryBuilder<T>
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
Returns TruncateQueryBuilder<T>
unsetFlag
Parameters
flag: QueryFlag
Returns QueryBuilder<T>
update
Parameters
data: EntityData<T>
Returns UpdateQueryBuilder<T>
where
Parameters
cond: string | QBFilterQuery<T>
optionalparams: any[] | $and | $or
optionaloperator: $and | $or
Returns TruncateQueryBuilder<T>
withSchema
Parameters
optionalschema: string
Returns QueryBuilder<T>
withSubQuery
Parameters
subQuery: QueryBuilder<any, any>
alias: string
Returns QueryBuilder<T>
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