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): IQueryBuilder<T>

• Parameters

  • fields: string | string[]

  Returns IQueryBuilder<T>

andWhere

• andWhere(cond): IQueryBuilder<T>
• andWhere(cond, params): IQueryBuilder<T>

• Parameters

  • cond: QBFilterQuery<T>

  Returns IQueryBuilder<T>

clone

• clone(reset): IQueryBuilder<T>

• Parameters

  • optionalreset: boolean

  Returns IQueryBuilder<T>

count

• count(field, distinct): IQueryBuilder<T>

• Parameters

  • optionalfield: string | string[]

  • optionaldistinct: boolean

  Returns IQueryBuilder<T>

delete

• delete(cond): IQueryBuilder<T>

• Parameters

  • optionalcond: QBFilterQuery

  Returns IQueryBuilder<T>

from

• from<T>(target, aliasName): IQueryBuilder<T>

• Type parameters

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

  Parameters

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

  • optionalaliasName: string

  Returns IQueryBuilder<T>

getAliasForJoinPath

• getAliasForJoinPath(path, options): undefined | string

• Parameters

  • path: string

  • optionaloptions: ICriteriaNodeProcessOptions

  Returns undefined | string

getJoinForPath

• getJoinForPath(path, options): undefined | JoinOptions

• Parameters

  • optionalpath: string

  • optionaloptions: ICriteriaNodeProcessOptions

  Returns undefined | JoinOptions

getNextAlias

• getNextAlias(entityName): string

• Parameters

  • optionalentityName: string

  Returns string

groupBy

• groupBy(fields): IQueryBuilder<T>

• Parameters

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

  Returns IQueryBuilder<T>

hasFlag

• hasFlag(flag): boolean

• Parameters

  • flag: QueryFlag

  Returns boolean

having

• having(cond, params): IQueryBuilder<T>

• Parameters

  • optionalcond: string | QBFilterQuery

  • optionalparams: any[]

  Returns IQueryBuilder<T>

innerJoin

• innerJoin(field, alias, cond): IQueryBuilder<T>

• Parameters

  • field: string

  • alias: string

  • optionalcond: QBFilterQuery

  Returns IQueryBuilder<T>

innerJoinAndSelect

• innerJoinAndSelect(field, alias, cond, fields): IQueryBuilder<T>

• Parameters

  • field: string

  • alias: string

  • optionalcond: QBFilterQuery

  • optionalfields: string[]

  Returns IQueryBuilder<T>

insert

• insert(data): IQueryBuilder<T>

• Parameters

  • data: any

  Returns IQueryBuilder<T>

join

• join(field, alias, cond, type, path): IQueryBuilder<T>

• Parameters

  • field: string

  • alias: string

  • optionalcond: QBFilterQuery

  • optionaltype: JoinType

  • optionalpath: string

  Returns IQueryBuilder<T>

joinAndSelect

• joinAndSelect(field, alias, cond): IQueryBuilder<T>

• Parameters

  • field: string

  • alias: string

  • optionalcond: QBFilterQuery

  Returns IQueryBuilder<T>

leftJoin

• leftJoin(field, alias, cond): IQueryBuilder<T>

• Parameters

  • field: string

  • alias: string

  • optionalcond: QBFilterQuery

  Returns IQueryBuilder<T>

leftJoinAndSelect

• leftJoinAndSelect(field, alias, cond, fields): IQueryBuilder<T>

• Parameters

  • field: string

  • alias: string

  • optionalcond: QBFilterQuery

  • optionalfields: string[]

  Returns IQueryBuilder<T>

orWhere

• orWhere(cond): IQueryBuilder<T>
• orWhere(cond, params): IQueryBuilder<T>

• Parameters

  • cond: QBFilterQuery<T>

  Returns IQueryBuilder<T>

orderBy

• orderBy(orderBy): IQueryBuilder<T>

• Parameters

  • orderBy: QueryOrderMap<T>

  Returns IQueryBuilder<T>

select

• select(fields, distinct): IQueryBuilder<T>

• Parameters

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

  • optionaldistinct: boolean

  Returns IQueryBuilder<T>

setFlag

• setFlag(flag): IQueryBuilder<T>

• Parameters

  • flag: QueryFlag

  Returns IQueryBuilder<T>

truncate

• truncate(): IQueryBuilder<T>

• Returns IQueryBuilder<T>

unsetFlag

• unsetFlag(flag): IQueryBuilder<T>

• Parameters

  • flag: QueryFlag

  Returns IQueryBuilder<T>

update

• update(data): IQueryBuilder<T>

• Parameters

  • data: any

  Returns IQueryBuilder<T>

where

• where(cond, operator): IQueryBuilder<T>
• where(cond, params, operator): IQueryBuilder<T>

• Parameters

  • cond: QBFilterQuery<T>

  • optionaloperator: $and | $or

  Returns IQueryBuilder<T>

withSubQuery

• withSubQuery(subQuery, alias): IQueryBuilder<T>

• Parameters

  • subQuery: QueryBuilder<any, any>

  • alias: string

  Returns IQueryBuilder<T>