Class Connection<C>

constructor

• new Connection<C = undefined>(
      database: Database<C>,
      driver: Driver,
      boundExecute?: ExecuteFn,
      isolation?: TransactionIsolation,
  ): Connection<C>

  Type Parameters

  • C = undefined

  Parameters

  • database: Database<C>
  • driver: Driver
  • OptionalboundExecute: ExecuteFn
  • Optionalisolation: TransactionIsolation

  Returns Connection<C>

Readonlydatabase

dialect

• get dialect(): DialectName

  Returns DialectName

close

• close(): Promise<void>

  Returns Promise<void>

execute

• execute<Q extends QueryBuilder<any, any, any, any>>(
      query: Q,
  ): Promise<
      Q extends QueryBuilder<any, O, any, any> ? RowTypeToTsType<O>[] : never,
  >

  Type Parameters

  • Q extends QueryBuilder<any, any, any, any>

  Parameters

  • query: Q

  Returns Promise<Q extends QueryBuilder<any, O, any, any> ? RowTypeToTsType<O>[] : never>

• execute<Q extends InsertBuilder<any, any, any>>(
      query: Q,
  ): Promise<
      Q extends InsertBuilder<any, any, R> ? RowTypeToTsType<R>[] : never,
  >

  Type Parameters

  • Q extends InsertBuilder<any, any, any>

  Parameters

  • query: Q

  Returns Promise<Q extends InsertBuilder<any, any, R> ? RowTypeToTsType<R>[] : never>

• execute<Q extends UpdateBuilder<any, any, any>>(
      query: Q,
  ): Promise<
      Q extends UpdateBuilder<any, any, R> ? RowTypeToTsType<R>[] : never,
  >

  Type Parameters

  • Q extends UpdateBuilder<any, any, any>

  Parameters

  • query: Q

  Returns Promise<Q extends UpdateBuilder<any, any, R> ? RowTypeToTsType<R>[] : never>

• execute<Q extends DeleteBuilder<any, any, any>>(
      query: Q,
  ): Promise<
      Q extends DeleteBuilder<any, any, R> ? RowTypeToTsType<R>[] : never,
  >

  Type Parameters

  • Q extends DeleteBuilder<any, any, any>

  Parameters

  • query: Q

  Returns Promise<Q extends DeleteBuilder<any, any, R> ? RowTypeToTsType<R>[] : never>

• execute(query: Sql): Promise<QueryResult>

  Parameters

  • query: Sql

  Returns Promise<QueryResult>

hydrate

• hydrate<
      O extends RowType,
      GB extends any[],
      Card extends "many" | "one" | "maybe",
  >(
      query: QueryBuilder<any, O, GB, Card>,
  ): Promise<O[]>

  Type Parameters

  • O extends RowType
  • GB extends any[]
  • Card extends "many" | "one" | "maybe"

  Parameters

  • query: QueryBuilder<any, O, GB, Card>

  Returns Promise<O[]>

• hydrate<Name extends string, T extends TableBase, R extends RowType>(
      query: InsertBuilder<Name, T, R>,
  ): Promise<R[]>

  Type Parameters

  • Name extends string
  • T extends TableBase
  • R extends RowType

  Parameters

  • query: InsertBuilder<Name, T, R>

  Returns Promise<R[]>

• hydrate<Name extends string, T extends TableBase, R extends RowType>(
      query: UpdateBuilder<Name, T, R>,
  ): Promise<R[]>

  Type Parameters

  • Name extends string
  • T extends TableBase
  • R extends RowType

  Parameters

  • query: UpdateBuilder<Name, T, R>

  Returns Promise<R[]>

• hydrate<Name extends string, T extends TableBase, R extends RowType>(
      query: DeleteBuilder<Name, T, R>,
  ): Promise<R[]>

  Type Parameters

  • Name extends string
  • T extends TableBase
  • R extends RowType

  Parameters

  • query: DeleteBuilder<Name, T, R>

  Returns Promise<R[]>

installLiveEvents

• installLiveEvents(): Promise<void>

  Returns Promise<void>

live

• live<Q extends QueryBuilder<any, any, any, any>>(
      query: Q,
  ): AsyncIterable<
      Q extends QueryBuilder<any, O, any, any> ? RowTypeToTsType<O>[] : never,
  >

  Type Parameters

  • Q extends QueryBuilder<any, any, any, any>

  Parameters

  • query: Q

  Returns AsyncIterable<
      Q extends QueryBuilder<any, O, any, any> ? RowTypeToTsType<O>[] : never,
  >

startLive

• startLive(opts?: BusOptions): Promise<void>

  Parameters

  • opts: BusOptions = {}

  Returns Promise<void>

stopLive

• stopLive(): Promise<void>

  Returns Promise<void>

transaction

• transaction<T>(fn: (tx: Connection<C>) => Promise<T>): Promise<T>

  Type Parameters

  • T

  Parameters

  • fn: (tx: Connection<C>) => Promise<T>

  Returns Promise<T>

• transaction<T>(
      opts: TransactionOptions,
      fn: (tx: Connection<C>) => Promise<T>,
  ): Promise<T>

  Type Parameters

  • T

  Parameters

  • opts: TransactionOptions
  • fn: (tx: Connection<C>) => Promise<T>

  Returns Promise<T>