DeleteQueryBuilder <T, RootAlias, Context>

Hierarchy

• RunQueryBuilder<T, RootAlias, Context>
  • DeleteQueryBuilder

Index

Properties

• __subquery
• alias
• helper
• mainAlias
• type

Methods

• addSelect
• andHaving
• andOrderBy
• andWhere
• applyFilters
• as
• cache
• clone
• comment
• count
• delete
• distinct
• distinctOn
• execute
• from
• getCount
• getFormattedQuery
• getLoggerContext
• getNativeQuery
• getParams
• getQuery
• getResultAndCount
• groupBy
• hasFlag
• having
• hintComment
• ignore
• indexHint
• innerJoin
• innerJoinAndSelect
• innerJoinLateral
• innerJoinLateralAndSelect
• insert
• join
• joinAndSelect
• leftJoin
• leftJoinAndSelect
• leftJoinLateral
• leftJoinLateralAndSelect
• limit
• merge
• offset
• onConflict
• orderBy
• orHaving
• orWhere
• returning
• select
• setFlag
• setFlushMode
• setLockMode
• setLoggerContext
• stream
• toQuery
• toRaw
• truncate
• unsetFlag
• update
• where
• withSchema
• withSubQuery

Properties

readonlyinherited__subquery

__subquery: true

Inherited from RunQueryBuilder.__subquery

inheritedalias

alias: string

Inherited from RunQueryBuilder.alias

inheritedhelper

helper: QueryBuilderHelper

Inherited from RunQueryBuilder.helper

inheritedmainAlias

mainAlias: Alias<T>

Inherited from RunQueryBuilder.mainAlias

inheritedtype

type: QueryType

Inherited from RunQueryBuilder.type

Methods

inheritedaddSelect

• addSelect<F>(fields): SelectQueryBuilder<T, RootAlias, never, Context, ExtractRawAliases<F extends readonly unknown[] ? F<F> : [F]>, * | ExtractRootFields<F extends readonly U[] ? U & string : F & string, RootAlias, Context>>

• Inherited from RunQueryBuilder.addSelect

  Adds fields to an existing SELECT query.

  ---

  Parameters

  • fields: F

  Returns SelectQueryBuilder<T, RootAlias, never, Context, ExtractRawAliases<F extends readonly unknown[] ? F<F> : [F]>, * | ExtractRootFields<F extends readonly U[] ? U & string : F & string, RootAlias, Context>>

inheritedandHaving

• andHaving(cond, params): SelectQueryBuilder<T, RootAlias, never, Context, never, *>

• Inherited from RunQueryBuilder.andHaving

  Parameters

  • optionalcond: string | QBFilterQuery<T, RootAlias, Context, never>

  • optionalparams: any[]

  Returns SelectQueryBuilder<T, RootAlias, never, Context, never, *>

inheritedandOrderBy

• andOrderBy(orderBy): SelectQueryBuilder<T, RootAlias, never, Context, never, *>
• andOrderBy<T>(orderBy): SelectQueryBuilder<T, RootAlias, never, Context, never, *>

• Inherited from RunQueryBuilder.andOrderBy

  Adds additional ORDER BY clause without replacing existing order.

  ---

  Parameters

  • orderBy: ContextOrderByMap<T, RootAlias, Context> | ContextOrderByMap<T, RootAlias, Context>[]

  Returns SelectQueryBuilder<T, RootAlias, never, Context, never, *>

inheritedandWhere

• andWhere(cond): this
• andWhere(cond, params): this

• Inherited from RunQueryBuilder.andWhere

  Adds an AND WHERE clause to the query using an object condition.

  @example

  qb.where({ status: 'active' }).andWhere({ role: 'admin' });
  qb.where({ name: 'John' }).andWhere({ 'b.title': 'test' });

  ---

  Parameters

  • cond: QBFilterQuery<T, RootAlias, Context, never>

  Returns this

inheritedapplyFilters

• applyFilters(filterOptions): Promise<void>

• Inherited from RunQueryBuilder.applyFilters

  Apply filters to the QB where condition.

  ---

  Parameters

  • filterOptions: FilterOptions = {}

  Returns Promise<void>

inheritedas

• as(alias): NativeQueryBuilder
• as<T>(targetEntity, alias): NativeQueryBuilder

• Inherited from RunQueryBuilder.as

  Returns native query builder instance with sub-query aliased with given alias.

  ---

  Parameters

  • alias: string

  Returns NativeQueryBuilder

inheritedcache

• cache(config): this

• Inherited from RunQueryBuilder.cache

  Parameters

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

  Returns this

inheritedclone

• clone(reset, preserve): QueryBuilder<T, RootAlias, never, Context, never, *>

• Inherited from RunQueryBuilder.clone

  Parameters

  • optionalreset: boolean | string[]

  • optionalpreserve: string[]

  Returns QueryBuilder<T, RootAlias, never, Context, never, *>

inheritedcomment

• comment(comment): this

• Inherited from RunQueryBuilder.comment

  Prepend comment to the sql query using the syntax /* ... *‍/. Some characters are forbidden such as /*, *‍/ and ?.

  ---

  Parameters

  • comment: undefined | string | string[]

  Returns this

inheritedcount

• count<F>(field, distinct): CountQueryBuilder<T>

• Inherited from RunQueryBuilder.count

  Creates a COUNT query to count matching rows.

  @example

  const count = await em.createQueryBuilder(User)
    .count()
    .where({ isActive: true })
    .execute('get');

  ---

  Parameters

  • optionalfield: F | F[]

  • distinct: boolean = false

  Returns CountQueryBuilder<T>

inheriteddelete

• delete(cond): DeleteQueryBuilder<T, RootAlias, Context>

• Inherited from RunQueryBuilder.delete

  Creates a DELETE query. Use where() to specify which rows to delete.

  @example

  await em.createQueryBuilder(User)
    .delete()
    .where({ id: 1 })
    .execute();
  
  // Or pass the condition directly
  await em.createQueryBuilder(User)
    .delete({ isActive: false })
    .execute();

  ---

  Parameters

  • optionalcond: QBFilterQuery<T, RootAlias, Context, never>

  Returns DeleteQueryBuilder<T, RootAlias, Context>

inheriteddistinct

• distinct(): SelectQueryBuilder<T, RootAlias, never, Context, never, *>

• Inherited from RunQueryBuilder.distinct

  Returns SelectQueryBuilder<T, RootAlias, never, Context, never, *>

inheriteddistinctOn

• distinctOn<F>(fields): SelectQueryBuilder<T, RootAlias, never, Context, never, *>
• distinctOn<F>(fields): SelectQueryBuilder<T, RootAlias, never, Context, never, *>

• Inherited from RunQueryBuilder.distinctOn

  postgres only

  ---

  Parameters

  • fields: F

  Returns SelectQueryBuilder<T, RootAlias, never, Context, never, *>

inheritedexecute

• execute<Result>(method, mapResults): Promise<Result>

• Inherited from RunQueryBuilder.execute

  Executes this QB and returns the raw results, mapped to the property names (unless disabled via last parameter). Use method to specify what kind of result you want to get (array/single/meta).

  ---

  Parameters

  • optionalmethod: get | all | run

  • optionalmapResults: boolean

  Returns Promise<Result>

inheritedfrom

• from<Entity>(target, aliasName): SelectQueryBuilder<Entity, RootAlias, never, Context, never, *>
• from<Entity>(target): SelectQueryBuilder<Entity, RootAlias, never, Context, never, *>

• 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.

  ---

  Parameters

  • target: QueryBuilder<Entity, never, never, never, never, *>

  • optionalaliasName: string

  Returns SelectQueryBuilder<Entity, RootAlias, never, Context, never, *>

inheritedgetCount

• getCount<F>(field, distinct): Promise<number>

• Inherited from RunQueryBuilder.getCount

  Executes count query (without offset and limit), returning total count of results

  ---

  Parameters

  • optionalfield: F | F[]

  • optionaldistinct: boolean

  Returns Promise<number>

inheritedgetFormattedQuery

• getFormattedQuery(): string

• Inherited from RunQueryBuilder.getFormattedQuery

  Returns raw interpolated query string with all the parameters inlined.

  ---

  Returns string

inheritedgetLoggerContext

• getLoggerContext<T>(): T

• Inherited from RunQueryBuilder.getLoggerContext

  Gets logger context for this query builder.

  ---

  Returns T

inheritedgetNativeQuery

• getNativeQuery(processVirtualEntity): NativeQueryBuilder

• Inherited from RunQueryBuilder.getNativeQuery

  Parameters

  • processVirtualEntity: boolean = true

  Returns NativeQueryBuilder

inheritedgetParams

• getParams(): readonly unknown[]

• Inherited from RunQueryBuilder.getParams

  Returns the list of all parameters for this query.

  ---

  Returns readonly unknown[]

inheritedgetQuery

• getQuery(): string

• Inherited from RunQueryBuilder.getQuery

  Returns the query with parameters as wildcards.

  ---

  Returns string

inheritedgetResultAndCount

• getResultAndCount(): Promise<[Loaded<T, never, *>[], number]>

• Inherited from RunQueryBuilder.getResultAndCount

  Executes the query, returning both array of results and total count query (without offset and limit).

  ---

  Returns Promise<[Loaded<T, never, *>[], number]>

inheritedgroupBy

• groupBy<F>(fields): SelectQueryBuilder<T, RootAlias, never, Context, never, *>
• groupBy<F>(fields): SelectQueryBuilder<T, RootAlias, never, Context, never, *>
• groupBy<P>(fields): SelectQueryBuilder<T, RootAlias, never, Context, never, *>

• Inherited from RunQueryBuilder.groupBy

  Adds a GROUP BY clause to the query.

  @example

  qb.select([raw('count(*) as count'), 'status'])
    .groupBy('status');

  ---

  Parameters

  • fields: F

  Returns SelectQueryBuilder<T, RootAlias, never, Context, never, *>

inheritedhasFlag

• hasFlag(flag): boolean

• Inherited from RunQueryBuilder.hasFlag

  Parameters

  • flag: QueryFlag

  Returns boolean

inheritedhaving

• having(cond, params, operator): SelectQueryBuilder<T, RootAlias, never, Context, never, *>

• Inherited from RunQueryBuilder.having

  Adds a HAVING clause to the query, typically used with GROUP BY.

  @example

  qb.select([raw('count(*) as count'), 'status'])
    .groupBy('status')
    .having({ count: { $gt: 5 } });

  ---

  Parameters

  • cond: string | QBFilterQuery<T, RootAlias, Context, never> = {}

  • optionalparams: any[]

  • optionaloperator: $and | $or

  Returns SelectQueryBuilder<T, RootAlias, never, Context, never, *>

inheritedhintComment

• hintComment(comment): this

• Inherited from RunQueryBuilder.hintComment

  Add hints to the query using comment-like syntax /*+ ... *‍/. 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: undefined | string | string[]

  Returns this

inheritedignore

• ignore(): this

• Inherited from RunQueryBuilder.ignore

  Returns this

inheritedindexHint

• indexHint(sql): this

• Inherited from RunQueryBuilder.indexHint

  Adds index hint to the FROM clause.

  ---

  Parameters

  • sql: undefined | string

  Returns this

inheritedinnerJoin

• innerJoin<Field, Alias>(field, alias, cond, schema): SelectQueryBuilder<T, RootAlias, never, ModifyContext<T, Context, Field, Alias, false>, never, *>
• innerJoin<Alias>(field, alias, cond, schema): SelectQueryBuilder<T, RootAlias, never, ModifyContext<T, Context, string, Alias, false>, never, *>

• Inherited from RunQueryBuilder.innerJoin

  Adds an INNER JOIN clause to the query for an entity relation.

  ---

  Parameters

  • field: Field

  • alias: Alias

  • optionalcond: JoinCondition<ExpandProperty<GetType<T, Context, Field>[GetPropName<Field> & keyof GetType<T, Context, Field>]>, Alias>

  • optionalschema: string

  Returns SelectQueryBuilder<T, RootAlias, never, ModifyContext<T, Context, Field, Alias, false>, never, *>

inheritedinnerJoinAndSelect

• innerJoinAndSelect<Field, Alias, JoinFields>(field, alias, cond, fields, schema): SelectQueryBuilder<T, RootAlias, (GetAlias<Field> extends Alias ? IsNever<Alias, true, false> extends true ? GetPropName<Field> : Alias extends RootAlias ? GetPropName<Field> : Alias extends keyof Context ? Context[Alias<Alias>] extends [Path, ...any[]] ? `${Path & string}.${GetPropName<Field>}` : GetPropName<Field> : GetPropName<Field> : GetPropName<Field>) & {}, ModifyContext<T, Context, Field, Alias, true>, never, ModifyFields<*, RootAlias, Context, Field, Alias, JoinFields>>

• Inherited from RunQueryBuilder.innerJoinAndSelect

  Parameters

  • field: Field | [Field, RawQueryFragment<string> | QueryBuilder<any, never, never, never, never, *>]

  • alias: Alias

  • cond: JoinCondition<ExpandProperty<GetType<T, Context, Field>[GetPropName<Field> & keyof GetType<T, Context, Field>]>, Alias> = ...

  • optionalfields: JoinFields

  • optionalschema: string

  Returns SelectQueryBuilder<T, RootAlias, (GetAlias<Field> extends Alias ? IsNever<Alias, true, false> extends true ? GetPropName<Field> : Alias extends RootAlias ? GetPropName<Field> : Alias extends keyof Context ? Context[Alias<Alias>] extends [Path, ...any[]] ? `${Path & string}.${GetPropName<Field>}` : GetPropName<Field> : GetPropName<Field> : GetPropName<Field>) & {}, ModifyContext<T, Context, Field, Alias, true>, never, ModifyFields<*, RootAlias, Context, Field, Alias, JoinFields>>

inheritedinnerJoinLateral

• innerJoinLateral<Alias>(field, alias, cond, schema): SelectQueryBuilder<T, RootAlias, never, ModifyContext<T, Context, string, Alias, false>, never, *>

• Inherited from RunQueryBuilder.innerJoinLateral

  Parameters

  • field: RawQueryFragment<string> | QueryBuilder<any, never, never, never, never, *>

  • alias: Alias

  • cond: RawJoinCondition = {}

  • optionalschema: string

  Returns SelectQueryBuilder<T, RootAlias, never, ModifyContext<T, Context, string, Alias, false>, never, *>

inheritedinnerJoinLateralAndSelect

• innerJoinLateralAndSelect<Field, Alias, JoinFields>(field, alias, cond, fields, schema): SelectQueryBuilder<T, RootAlias, (GetAlias<Field> extends Alias ? IsNever<Alias, true, false> extends true ? GetPropName<Field> : Alias extends RootAlias ? GetPropName<Field> : Alias extends keyof Context ? Context[Alias<Alias>] extends [Path, ...any[]] ? `${Path & string}.${GetPropName<Field>}` : GetPropName<Field> : GetPropName<Field> : GetPropName<Field>) & {}, ModifyContext<T, Context, Field, Alias, true>, never, ModifyFields<*, RootAlias, Context, Field, Alias, JoinFields>>

• Inherited from RunQueryBuilder.innerJoinLateralAndSelect

  Parameters

  • field: [Field, RawQueryFragment<string> | QueryBuilder<any, never, never, never, never, *>]

  • alias: Alias

  • cond: JoinCondition<ExpandProperty<GetType<T, Context, Field>[GetPropName<Field> & keyof GetType<T, Context, Field>]>, Alias> = ...

  • optionalfields: JoinFields

  • optionalschema: string

  Returns SelectQueryBuilder<T, RootAlias, (GetAlias<Field> extends Alias ? IsNever<Alias, true, false> extends true ? GetPropName<Field> : Alias extends RootAlias ? GetPropName<Field> : Alias extends keyof Context ? Context[Alias<Alias>] extends [Path, ...any[]] ? `${Path & string}.${GetPropName<Field>}` : GetPropName<Field> : GetPropName<Field> : GetPropName<Field>) & {}, ModifyContext<T, Context, Field, Alias, true>, never, ModifyFields<*, RootAlias, Context, Field, Alias, JoinFields>>

inheritedinsert

• insert(data): InsertQueryBuilder<T, RootAlias, Context>

• Inherited from RunQueryBuilder.insert

  Creates an INSERT query with the given data.

  @example

  await em.createQueryBuilder(User)
    .insert({ name: 'John', email: 'john@example.com' })
    .execute();
  
  // Bulk insert
  await em.createQueryBuilder(User)
    .insert([{ name: 'John' }, { name: 'Jane' }])
    .execute();

  ---

  Parameters

  • data: RequiredEntityData<T> | RequiredEntityData<T>[]

  Returns InsertQueryBuilder<T, RootAlias, Context>

inheritedjoin

• join<Field, Alias>(field, alias, cond, type, path, schema): SelectQueryBuilder<T, RootAlias, never, ModifyContext<T, Context, Field, Alias, false>, never, *>
• join<Alias>(field, alias, cond, type, path, schema): SelectQueryBuilder<T, RootAlias, never, ModifyContext<T, Context, string, Alias, false>, never, *>

• Inherited from RunQueryBuilder.join

  Adds a JOIN clause to the query for an entity relation.

  @example

  const qb = em.createQueryBuilder(Book, 'b');
  qb.select('*')
    .join('b.author', 'a')
    .where({ 'a.name': 'John' });

  ---

  Parameters

  • field: Field

  • alias: Alias

  • optionalcond: JoinCondition<ExpandProperty<GetType<T, Context, Field>[GetPropName<Field> & keyof GetType<T, Context, Field>]>, Alias>

  • optionaltype: JoinType

  • optionalpath: string

  • optionalschema: string

  Returns SelectQueryBuilder<T, RootAlias, never, ModifyContext<T, Context, Field, Alias, false>, never, *>

inheritedjoinAndSelect

• joinAndSelect<Field, Alias, JoinFields>(field, alias, cond, type, path, fields, schema): SelectQueryBuilder<T, RootAlias, (GetAlias<Field> extends Alias ? IsNever<Alias, true, false> extends true ? GetPropName<Field> : Alias extends RootAlias ? GetPropName<Field> : Alias extends keyof Context ? Context[Alias<Alias>] extends [Path, ...any[]] ? `${Path & string}.${GetPropName<Field>}` : GetPropName<Field> : GetPropName<Field> : GetPropName<Field>) & {}, ModifyContext<T, Context, Field, Alias, true>, never, ModifyFields<*, RootAlias, Context, Field, Alias, JoinFields>>

• Inherited from RunQueryBuilder.joinAndSelect

  Adds a JOIN clause and automatically selects the joined entity's fields. This is useful for eager loading related entities.

  @example

  const qb = em.createQueryBuilder(Book, 'b');
  qb.select('*')
    .joinAndSelect('b.author', 'a')
    .where({ 'a.name': 'John' });

  ---

  Parameters

  • field: Field | [Field, RawQueryFragment<string> | QueryBuilder<any, never, never, never, never, *>]

  • alias: Alias

  • cond: JoinCondition<ExpandProperty<GetType<T, Context, Field>[GetPropName<Field> & keyof GetType<T, Context, Field>]>, Alias> = ...

  • type: JoinType = JoinType.innerJoin

  • optionalpath: string

  • optionalfields: JoinFields

  • optionalschema: string

  Returns SelectQueryBuilder<T, RootAlias, (GetAlias<Field> extends Alias ? IsNever<Alias, true, false> extends true ? GetPropName<Field> : Alias extends RootAlias ? GetPropName<Field> : Alias extends keyof Context ? Context[Alias<Alias>] extends [Path, ...any[]] ? `${Path & string}.${GetPropName<Field>}` : GetPropName<Field> : GetPropName<Field> : GetPropName<Field>) & {}, ModifyContext<T, Context, Field, Alias, true>, never, ModifyFields<*, RootAlias, Context, Field, Alias, JoinFields>>

inheritedleftJoin

• leftJoin<Field, Alias>(field, alias, cond, schema): SelectQueryBuilder<T, RootAlias, never, ModifyContext<T, Context, Field, Alias, false>, never, *>
• leftJoin<Alias>(field, alias, cond, schema): SelectQueryBuilder<T, RootAlias, never, ModifyContext<T, Context, string, Alias, false>, never, *>

• Inherited from RunQueryBuilder.leftJoin

  Adds a LEFT JOIN clause to the query for an entity relation.

  ---

  Parameters

  • field: Field

  • alias: Alias

  • optionalcond: JoinCondition<ExpandProperty<GetType<T, Context, Field>[GetPropName<Field> & keyof GetType<T, Context, Field>]>, Alias>

  • optionalschema: string

  Returns SelectQueryBuilder<T, RootAlias, never, ModifyContext<T, Context, Field, Alias, false>, never, *>

inheritedleftJoinAndSelect

• leftJoinAndSelect<Field, Alias, JoinFields>(field, alias, cond, fields, schema): SelectQueryBuilder<T, RootAlias, (GetAlias<Field> extends Alias ? IsNever<Alias, true, false> extends true ? GetPropName<Field> : Alias extends RootAlias ? GetPropName<Field> : Alias extends keyof Context ? Context[Alias<Alias>] extends [Path, ...any[]] ? `${Path & string}.${GetPropName<Field>}` : GetPropName<Field> : GetPropName<Field> : GetPropName<Field>) & {}, ModifyContext<T, Context, Field, Alias, true>, never, ModifyFields<*, RootAlias, Context, Field, Alias, JoinFields>>

• Inherited from RunQueryBuilder.leftJoinAndSelect

  Parameters

  • field: Field | [Field, RawQueryFragment<string> | QueryBuilder<any, never, never, never, never, *>]

  • alias: Alias

  • cond: JoinCondition<ExpandProperty<GetType<T, Context, Field>[GetPropName<Field> & keyof GetType<T, Context, Field>]>, Alias> = ...

  • optionalfields: JoinFields

  • optionalschema: string

  Returns SelectQueryBuilder<T, RootAlias, (GetAlias<Field> extends Alias ? IsNever<Alias, true, false> extends true ? GetPropName<Field> : Alias extends RootAlias ? GetPropName<Field> : Alias extends keyof Context ? Context[Alias<Alias>] extends [Path, ...any[]] ? `${Path & string}.${GetPropName<Field>}` : GetPropName<Field> : GetPropName<Field> : GetPropName<Field>) & {}, ModifyContext<T, Context, Field, Alias, true>, never, ModifyFields<*, RootAlias, Context, Field, Alias, JoinFields>>

inheritedleftJoinLateral

• leftJoinLateral<Alias>(field, alias, cond, schema): SelectQueryBuilder<T, RootAlias, never, ModifyContext<T, Context, string, Alias, false>, never, *>

• Inherited from RunQueryBuilder.leftJoinLateral

  Parameters

  • field: RawQueryFragment<string> | QueryBuilder<any, never, never, never, never, *>

  • alias: Alias

  • cond: RawJoinCondition = {}

  • optionalschema: string

  Returns SelectQueryBuilder<T, RootAlias, never, ModifyContext<T, Context, string, Alias, false>, never, *>

inheritedleftJoinLateralAndSelect

• leftJoinLateralAndSelect<Field, Alias, JoinFields>(field, alias, cond, fields, schema): SelectQueryBuilder<T, RootAlias, (GetAlias<Field> extends Alias ? IsNever<Alias, true, false> extends true ? GetPropName<Field> : Alias extends RootAlias ? GetPropName<Field> : Alias extends keyof Context ? Context[Alias<Alias>] extends [Path, ...any[]] ? `${Path & string}.${GetPropName<Field>}` : GetPropName<Field> : GetPropName<Field> : GetPropName<Field>) & {}, ModifyContext<T, Context, Field, Alias, true>, never, ModifyFields<*, RootAlias, Context, Field, Alias, JoinFields>>

• Inherited from RunQueryBuilder.leftJoinLateralAndSelect

  Parameters

  • field: [Field, RawQueryFragment<string> | QueryBuilder<any, never, never, never, never, *>]

  • alias: Alias

  • cond: JoinCondition<ExpandProperty<GetType<T, Context, Field>[GetPropName<Field> & keyof GetType<T, Context, Field>]>, Alias> = ...

  • optionalfields: JoinFields

  • optionalschema: string

  Returns SelectQueryBuilder<T, RootAlias, (GetAlias<Field> extends Alias ? IsNever<Alias, true, false> extends true ? GetPropName<Field> : Alias extends RootAlias ? GetPropName<Field> : Alias extends keyof Context ? Context[Alias<Alias>] extends [Path, ...any[]] ? `${Path & string}.${GetPropName<Field>}` : GetPropName<Field> : GetPropName<Field> : GetPropName<Field>) & {}, ModifyContext<T, Context, Field, Alias, true>, never, ModifyFields<*, RootAlias, Context, Field, Alias, JoinFields>>

inheritedlimit

• limit(limit, offset): SelectQueryBuilder<T, RootAlias, never, Context, never, *>

• Inherited from RunQueryBuilder.limit

  Sets a LIMIT clause to restrict the number of results.

  @example

  qb.select('*').limit(10);        // First 10 results
  qb.select('*').limit(10, 20);    // 10 results starting from offset 20

  ---

  Parameters

  • optionallimit: number

  • offset: number = 0

  Returns SelectQueryBuilder<T, RootAlias, never, Context, never, *>

inheritedmerge

• merge<P>(data): this
• merge<F>(data): this

• Inherited from RunQueryBuilder.merge

  Parameters

  • data: readonly NestedAutoPath<T, RootAlias, Context, P>[]

  Returns this

inheritedoffset

• offset(offset): SelectQueryBuilder<T, RootAlias, never, Context, never, *>

• Inherited from RunQueryBuilder.offset

  Sets an OFFSET clause to skip a number of results.

  @example

  qb.select('*').limit(10).offset(20);  // Results 21-30

  ---

  Parameters

  • optionaloffset: number

  Returns SelectQueryBuilder<T, RootAlias, never, Context, never, *>

inheritedonConflict

• onConflict<F>(fields): InsertQueryBuilder<T, RootAlias, Context>

• Inherited from RunQueryBuilder.onConflict

  Parameters

  • fields: RawQueryFragment<string> | F | F[] = ...

  Returns InsertQueryBuilder<T, RootAlias, Context>

inheritedorderBy

• orderBy(orderBy): SelectQueryBuilder<T, RootAlias, never, Context, never, *>
• orderBy<T>(orderBy): SelectQueryBuilder<T, RootAlias, never, Context, never, *>

• Inherited from RunQueryBuilder.orderBy

  Adds an ORDER BY clause to the query, replacing any existing order.

  @example

  qb.orderBy({ name: 'asc', createdAt: 'desc' });
  qb.orderBy([{ name: 'asc' }, { createdAt: 'desc' }]);
  qb.orderBy({ profile: { bio: 'asc' } }); // nested via object
  qb.orderBy({ 'profile.bio': 'asc' }); // nested via dot notation

  ---

  Parameters

  • orderBy: ContextOrderByMap<T, RootAlias, Context> | ContextOrderByMap<T, RootAlias, Context>[]

  Returns SelectQueryBuilder<T, RootAlias, never, Context, never, *>

inheritedorHaving

• orHaving(cond, params): SelectQueryBuilder<T, RootAlias, never, Context, never, *>

• Inherited from RunQueryBuilder.orHaving

  Parameters

  • optionalcond: string | QBFilterQuery<T, RootAlias, Context, never>

  • optionalparams: any[]

  Returns SelectQueryBuilder<T, RootAlias, never, Context, never, *>

inheritedorWhere

• orWhere(cond): this
• orWhere(cond, params): this

• Inherited from RunQueryBuilder.orWhere

  Adds an OR WHERE clause to the query using an object condition.

  @example

  qb.where({ status: 'active' }).orWhere({ role: 'admin' });
  qb.where({ name: 'John' }).orWhere({ name: 'Jane' });

  ---

  Parameters

  • cond: QBFilterQuery<T, RootAlias, Context, never>

  Returns this

inheritedreturning

• returning<F>(fields): this

• Inherited from RunQueryBuilder.returning

  Parameters

  • optionalfields: F | F[]

  Returns this

inheritedselect

• select<F>(fields, distinct): SelectQueryBuilder<T, RootAlias, never, Context, ExtractRawAliases<F>, ExtractRootFields<F[number] & string, RootAlias, Context>>
• select<P>(fields, distinct): SelectQueryBuilder<T, RootAlias, never, Context, never, ExtractRootFields<P, RootAlias, Context>>
• select<P>(fields, distinct): SelectQueryBuilder<T, RootAlias, never, Context, never, ExtractRootFields<P, RootAlias, Context>>
• select<F>(fields, distinct): SelectQueryBuilder<T, RootAlias, never, Context, ExtractRawAliasFromField<F>, ExtractRootFields<F & string, RootAlias, Context>>

• Inherited from RunQueryBuilder.select

  Creates a SELECT query, specifying the fields to retrieve.

  @example

  // Select specific fields
  const qb = em.createQueryBuilder(User, 'u');
  qb.select(['u.id', 'u.name', 'u.email']);
  
  // Select with raw expressions
  qb.select([raw('count(*) as total')]);
  
  // Select with distinct
  qb.select('*', true);

  ---

  Parameters

  • fields: F

  • optionaldistinct: boolean

  Returns SelectQueryBuilder<T, RootAlias, never, Context, ExtractRawAliases<F>, ExtractRootFields<F[number] & string, RootAlias, Context>>

inheritedsetFlag

• setFlag(flag): this

• Inherited from RunQueryBuilder.setFlag

  Parameters

  • flag: QueryFlag

  Returns this

inheritedsetFlushMode

• setFlushMode(flushMode): this

• Inherited from RunQueryBuilder.setFlushMode

  Parameters

  • optionalflushMode: FlushMode

  Returns this

inheritedsetLockMode

• setLockMode(mode, tables): this

• Inherited from RunQueryBuilder.setLockMode

  Parameters

  • optionalmode: LockMode

  • optionaltables: string[]

  Returns this

inheritedsetLoggerContext

• setLoggerContext(context): void

• Inherited from RunQueryBuilder.setLoggerContext

  Sets logger context for this query builder.

  ---

  Parameters

  • context: LoggingOptions & Dictionary

  Returns void

inheritedstream

• stream(options): AsyncIterableIterator<Loaded<T, never, *>, any, any>

• Inherited from RunQueryBuilder.stream

  Executes the query and returns an async iterable (async generator) that yields results one by one. By default, the results are merged and mapped to entity instances, without adding them to the identity map. You can disable merging and mapping by passing the options { mergeResults: false, mapResults: false }. This is useful for processing large datasets without loading everything into memory at once.

  const qb = em.createQueryBuilder(Book, 'b');
  qb.select('*').where({ title: '1984' }).leftJoinAndSelect('b.author', 'a');
  
  for await (const book of qb.stream()) {
    // book is an instance of Book entity
    console.log(book.title, book.author.name);
  }

  ---

  Parameters

  • optionaloptions: QBStreamOptions

  Returns AsyncIterableIterator<Loaded<T, never, *>, any, any>

inheritedtoQuery

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

• Inherited from RunQueryBuilder.toQuery

  Returns { params: readonly unknown[]; sql: string }

  • params: readonly unknown[]

  • sql: string

inheritedtoRaw

• toRaw(): RawQueryFragment<string>

• Inherited from RunQueryBuilder.toRaw

  Returns raw fragment representation of this QueryBuilder.

  ---

  Returns RawQueryFragment<string>

inheritedtruncate

• truncate(): TruncateQueryBuilder<T>

• Inherited from RunQueryBuilder.truncate

  Creates a TRUNCATE query to remove all rows from the table.

  ---

  Returns TruncateQueryBuilder<T>

inheritedunsetFlag

• unsetFlag(flag): this

• Inherited from RunQueryBuilder.unsetFlag

  Parameters

  • flag: QueryFlag

  Returns this

inheritedupdate

• update(data): UpdateQueryBuilder<T, RootAlias, Context>

• Inherited from RunQueryBuilder.update

  Creates an UPDATE query with the given data. Use where() to specify which rows to update.

  @example

  await em.createQueryBuilder(User)
    .update({ name: 'John Doe' })
    .where({ id: 1 })
    .execute();

  ---

  Parameters

  • data: EntityData<T>

  Returns UpdateQueryBuilder<T, RootAlias, Context>

inheritedwhere

• where(cond, params, operator): this

• Inherited from RunQueryBuilder.where

  Parameters

  • cond: string | QBFilterQuery<T, RootAlias, Context, never>

  • optionalparams: any[] | $and | $or

  • optionaloperator: $and | $or

  Returns this

inheritedwithSchema

• withSchema(schema): this

• Inherited from RunQueryBuilder.withSchema

  Parameters

  • optionalschema: string

  Returns this

inheritedwithSubQuery

• withSubQuery(subQuery, alias): this

• Inherited from RunQueryBuilder.withSubQuery

  Parameters

  • subQuery: RawQueryFragment<string> | NativeQueryBuilder

  • alias: string

  Returns this