IQueryBuilder <T>

Index

Properties

• _fields
• alias
• type

Methods

• addSelect
• andWhere
• clone
• count
• delete
• from
• getAliasForJoinPath
• getJoinForPath
• getNextAlias
• groupBy
• hasFlag
• having
• innerJoin
• innerJoinAndSelect
• insert
• join
• joinAndSelect
• leftJoin
• leftJoinAndSelect
• orWhere
• orderBy
• select
• setFlag
• truncate
• unsetFlag
• update
• where
• withSubQuery

Properties

optional_fields

_fields?: Field<T>[]

readonlyalias

alias: string

optionalreadonlytype

type?: QueryType

Methods

addSelect

• addSelect(fields: string | string[]): this

• Parameters

  • fields: string | string[]

  Returns this

andWhere

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

• Parameters

  • cond: QBFilterQuery<T>

  Returns this

clone

• clone(reset?: boolean): IQueryBuilder<T>

• Parameters

  • optionalreset: boolean

  Returns IQueryBuilder<T>

count

• count(field?: string | string[], distinct?: boolean): this

• Parameters

  • optionalfield: string | string[]

  • optionaldistinct: boolean

  Returns this

delete

• delete(cond?: QBFilterQuery): this

• Parameters

  • optionalcond: QBFilterQuery

  Returns this

from

• from<T>(target: EntityName<T> | IQueryBuilder<T>, aliasName?: string): IQueryBuilder<T>

• Type parameters

  • T: Partial<T> = Partial<any>

  Parameters

  • target: EntityName<T> | IQueryBuilder<T>

  • optionalaliasName: string

  Returns IQueryBuilder<T>

getAliasForJoinPath

• getAliasForJoinPath(path: string, options?: ICriteriaNodeProcessOptions): undefined | string

• Parameters

  • path: string

  • optionaloptions: ICriteriaNodeProcessOptions

  Returns undefined | string

getJoinForPath

• getJoinForPath(path?: string, options?: ICriteriaNodeProcessOptions): undefined | JoinOptions

• Parameters

  • optionalpath: string

  • optionaloptions: ICriteriaNodeProcessOptions

  Returns undefined | JoinOptions

getNextAlias

• getNextAlias(entityName?: string): string

• Parameters

  • optionalentityName: string

  Returns string

groupBy

• groupBy(fields: string | keyof T | (string | keyof T)[]): this

• Parameters

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

  Returns this

hasFlag

• hasFlag(flag: QueryFlag): boolean

• Parameters

  • flag: QueryFlag

  Returns boolean

having

• having(cond?: string | QBFilterQuery, params?: any[]): this

• Parameters

  • optionalcond: string | QBFilterQuery

  • optionalparams: any[]

  Returns this

innerJoin

• innerJoin(field: string, alias: string, cond?: QBFilterQuery): this

• Parameters

  • field: string

  • alias: string

  • optionalcond: QBFilterQuery

  Returns this

innerJoinAndSelect

• innerJoinAndSelect(field: string, alias: string, cond?: QBFilterQuery, fields?: string[]): this

• Parameters

  • field: string

  • alias: string

  • optionalcond: QBFilterQuery

  • optionalfields: string[]

  Returns this

insert

• insert(data: any): this

• Parameters

  • data: any

  Returns this

join

• join(field: string, alias: string, cond?: QBFilterQuery, type?: JoinType, path?: string): this

• Parameters

  • field: string

  • alias: string

  • optionalcond: QBFilterQuery

  • optionaltype: JoinType

  • optionalpath: string

  Returns this

joinAndSelect

• joinAndSelect(field: string, alias: string, cond?: QBFilterQuery): this

• Parameters

  • field: string

  • alias: string

  • optionalcond: QBFilterQuery

  Returns this

leftJoin

• leftJoin(field: string, alias: string, cond?: QBFilterQuery): this

• Parameters

  • field: string

  • alias: string

  • optionalcond: QBFilterQuery

  Returns this

leftJoinAndSelect

• leftJoinAndSelect(field: string, alias: string, cond?: QBFilterQuery, fields?: string[]): this

• Parameters

  • field: string

  • alias: string

  • optionalcond: QBFilterQuery

  • optionalfields: string[]

  Returns this

orWhere

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

• Parameters

  • cond: QBFilterQuery<T>

  Returns this

orderBy

• orderBy(orderBy: QueryOrderMap<T>): this

• Parameters

  • orderBy: QueryOrderMap<T>

  Returns this

select

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

• Parameters

  • fields: Field<T> | Field<T>[]

  • optionaldistinct: boolean

  Returns this

setFlag

• setFlag(flag: QueryFlag): this

• Parameters

  • flag: QueryFlag

  Returns this

truncate

• truncate(): this

• Returns this

unsetFlag

• unsetFlag(flag: QueryFlag): this

• Parameters

  • flag: QueryFlag

  Returns this

update

• update(data: any): this

• Parameters

  • data: any

  Returns this

where

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

• Parameters

  • cond: QBFilterQuery<T>

  • optionaloperator: $and | $or

  Returns this

withSubQuery

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

• Parameters

  • subQuery: QueryBuilder<any, any>

  • alias: string

  Returns this