Class OpaqueQuery<S>

constructor

• new OpaqueQuery<S extends ReadObject>(
      knex: Knex,
      sql: QueryBuilder,
      options: QueryOutput<S>,
  ): OpaqueQuery<S>
  Internal

  Use a query's apply() or selectRaw() method.

  Type Parameters

  • S extends ReadObject

  Parameters

  • knex: Knex
  • sql: QueryBuilder
  • options: QueryOutput<S>

  Returns OpaqueQuery<S>

ReadonlyrowSchema

apply

• apply<O extends ReadObject>(
      configure: (query: QueryBuilder) => QueryBuilder<any, any> | undefined,
      options: QueryOutput<O>,
  ): OpaqueQuery<O>

  Configure isolated Knex SQL once; every opaque change must declare its resulting output.

  Type Parameters

  • O extends ReadObject

  Parameters

  • configure: (query: QueryBuilder) => QueryBuilder<any, any> | undefined
  • options: QueryOutput<O>

  Returns OpaqueQuery<O>

execute

• execute(): Promise<InferType<S>[]>

  Execute again on every call and synchronously parse each raw row exactly once.

  Returns Promise<InferType<S>[]>

first

• first(): Promise<InferType<S> | undefined>

  Fetch the first row, or undefined.

  Returns Promise<InferType<S> | undefined>

limit

• limit(count: number): OpaqueQuery<S>

  Limit an independent query while keeping schema identity.

  Parameters

  • count: number

  Returns OpaqueQuery<S>

offset

• offset(count: number): OpaqueQuery<S>

  Offset an independent query while keeping schema identity.

  Parameters

  • count: number

  Returns OpaqueQuery<S>

then

• then<R = InferType<S>[], E = never>(
      resolve?: ((rows: InferType<S>[]) => R | PromiseLike<R>) | null,
      reject?: ((error: any) => E | PromiseLike<E>) | null,
  ): Promise<R | E>

  Awaiting executes this query; results are not cached.

  Type Parameters

  • R = InferType<S>[]
  • E = never

  Parameters

  • Optionalresolve: ((rows: InferType<S>[]) => R | PromiseLike<R>) | null
  • Optionalreject: ((error: any) => E | PromiseLike<E>) | null

  Returns Promise<R | E>

toKnexQuery

• toKnexQuery(): QueryBuilder

  Return an independent mutable SQL snapshot.

  Returns QueryBuilder

toQuery

• toQuery(): string

  Render debug SQL without execution.

  Returns string

transacting

• transacting(trx: Transaction): OpaqueQuery<S>

  Bind an independent query to an existing transaction.

  Parameters

  • trx: Transaction

  Returns OpaqueQuery<S>

Staticcapture

• capture<S extends ReadObject>(
      knex: Knex,
      sql: QueryBuilder,
      options: QueryOutput<S>,
  ): OpaqueQuery<S>
  Internal

  Capture the completed SELECT; external builders and callbacks are not retained.

  Type Parameters

  • S extends ReadObject

  Parameters

  • knex: Knex
  • sql: QueryBuilder
  • options: QueryOutput<S>

  Returns OpaqueQuery<S>