Class QueryBuilder<N, O, GB, Card>

constructor

• new QueryBuilder<
      N extends Namespace,
      O extends RowType,
      GB extends Any<any>[],
      Card extends Cardinality = "many",
  >(
      opts: QueryBuilderOptions<N, O, GB>,
      card?: Card,
  ): QueryBuilder<N, O, GB, Card>

  Type Parameters

  • N extends Namespace
  • O extends RowType
  • GB extends Any<any>[]
  • Card extends Cardinality = "many"

  Parameters

  • opts: QueryBuilderOptions<N, O, GB>
  • Optionalcard: Card

  Returns QueryBuilder<N, O, GB, Card>

Readonlyopts

tsAlias

• get tsAlias(): string

  Returns string

bind

• bind(): BoundSql

  Returns BoundSql

cardinality

• cardinality<C extends Cardinality>(card: C): QueryBuilder<N, O, GB, C>

  Type Parameters

  • C extends Cardinality

  Parameters

  • card: C

  Returns QueryBuilder<N, O, GB, C>

children

• children(): FinalizedQuery[]

  Returns FinalizedQuery[]

debug

• debug(): this

  Returns this

execute

• execute(db: Database<any>): Promise<RowTypeToTsType<O>[]>

  Parameters

  • db: Database<any>

  Returns Promise<RowTypeToTsType<O>[]>

finalize

• finalize(): FinalizedQuery

  Returns FinalizedQuery

groupBy

• groupBy(): QueryBuilder<
      { [K in string
      | number
      | symbol]: AggregateRow<N[K]> },
      {},
      GB,
      Card,
  >

  Returns QueryBuilder<
      { [K in string
      | number
      | symbol]: AggregateRow<N[K]> },
      {},
      GB,
      Card,
  >

• groupBy<G extends Any<any>[]>(
      groupBy: (n: N) => [...G[]],
  ): QueryBuilder<
      { [K in string
      | number
      | symbol]: AggregateRow<N[K]> } & G,
      {},
      [...GB[], ...G[]],
      Card,
  >

  Type Parameters

  • G extends Any<any>[]

  Parameters

  • groupBy: (n: N) => [...G[]]

  Returns QueryBuilder<
      { [K in string
      | number
      | symbol]: AggregateRow<N[K]> } & G,
      {},
      [...GB[], ...G[]],
      Card,
  >

having

• having(having: (n: N) => Bool<any>): QueryBuilder<N, O, GB>

  Parameters

  • having: (n: N) => Bool<any>

  Returns QueryBuilder<N, O, GB>

hydrate

• hydrate(db: Database<any>): Promise<O[]>

  Parameters

  • db: Database<any>

  Returns Promise<O[]>

join

• join<T extends typeof TableBase>(
      from: T,
      on: (ns: N & { [K in string]: InstanceType<T> }) => Bool<any>,
  ): QueryBuilder<N & { [K in string]: InstanceType<T> }, O, GB>

  Type Parameters

  • T extends typeof TableBase

  Parameters

  • from: T
  • on: (ns: N & { [K in string]: InstanceType<T> }) => Bool<any>

  Returns QueryBuilder<N & { [K in string]: InstanceType<T> }, O, GB>

• join<R extends RowType, A extends string>(
      from: Fromable<R, A>,
      on: (ns: N & { [k in string]: R }) => Bool<any>,
  ): QueryBuilder<N & { [k in string]: R }, O, GB>

  Type Parameters

  • R extends RowType
  • A extends string

  Parameters

  • from: Fromable<R, A>
  • on: (ns: N & { [k in string]: R }) => Bool<any>

  Returns QueryBuilder<N & { [k in string]: R }, O, GB>

leftJoin

• leftJoin<T extends typeof TableBase>(
      from: T,
      on: (
          ns: N & { [K in string]: RowTypeToNullable<InstanceType<T>> },
      ) => Bool<any>,
  ): QueryBuilder<
      N & { [K in string]: RowTypeToNullable<InstanceType<T>> },
      O,
      GB,
  >

  Type Parameters

  • T extends typeof TableBase

  Parameters

  • from: T
  • on: (ns: N & { [K in string]: RowTypeToNullable<InstanceType<T>> }) => Bool<any>

  Returns QueryBuilder<N & { [K in string]: RowTypeToNullable<InstanceType<T>> }, O, GB>

• leftJoin<R extends RowType, A extends string>(
      from: Fromable<R, A>,
      onFn: (ns: N & { [k in string]: RowTypeToNullable<R> }) => Bool<any>,
  ): QueryBuilder<N & { [k in string]: RowTypeToNullable<R> }, O, GB>

  Type Parameters

  • R extends RowType
  • A extends string

  Parameters

  • from: Fromable<R, A>
  • onFn: (ns: N & { [k in string]: RowTypeToNullable<R> }) => Bool<any>

  Returns QueryBuilder<N & { [k in string]: RowTypeToNullable<R> }, O, GB>

limit

• limit(n: number): QueryBuilder<N, O, GB>

  Parameters

  • n: number

  Returns QueryBuilder<N, O, GB>

live

• live(db: Database<any>): AsyncIterable<RowTypeToTsType<O>[]>

  Parameters

  • db: Database<any>

  Returns AsyncIterable<RowTypeToTsType<O>[]>

maybeOne

• maybeOne(db: Database<any>): Promise<O | null>

  Parameters

  • db: Database<any>

  Returns Promise<O | null>

offset

• offset(n: number): QueryBuilder<N, O, GB>

  Parameters

  • n: number

  Returns QueryBuilder<N, O, GB>

one

• one(db: Database<any>): Promise<O>

  Parameters

  • db: Database<any>

  Returns Promise<O>

orderBy

• orderBy(
      orderBy: (n: N) => OrderByEntry | [OrderByEntry, ...OrderByEntry[]],
  ): QueryBuilder<N, O, GB, Card>

  Parameters

  • orderBy: (n: N) => OrderByEntry | [OrderByEntry, ...OrderByEntry[]]

  Returns QueryBuilder<N, O, GB, Card>

rowType

• rowType(): O

  Returns O

scalar

• scalar(): [Card] extends ["one"]
      ? Record<O, 1>
      : [Card] extends ["maybe"] ? Record<O, 0 | 1> : Anyarray<Record<O, 1>, 1>

  Returns [Card] extends ["one"]
      ? Record<O, 1>
      : [Card] extends ["maybe"] ? Record<O, 0 | 1> : Anyarray<Record<O, 1>, 1>

select

• select<O2 extends RowType>(select: (n: N) => O2): QueryBuilder<N, O2, GB, Card>

  Type Parameters

  • O2 extends RowType

  Parameters

  • select: (n: N) => O2

  Returns QueryBuilder<N, O2, GB, Card>

where

• where(where: (n: N) => Bool<any>): QueryBuilder<N, O, GB>

  Parameters

  • where: (n: N) => Bool<any>

  Returns QueryBuilder<N, O, GB>