Last Updated: 3/9/2026

kysely

• DatabaseConnection

Interface DatabaseConnection

A single connection to the database engine.

These are created by an instance of Driver.

interface DatabaseConnection {
    executeQuery<R>(compiledQuery: CompiledQuery): Promise<QueryResult<R>>;
    streamQuery<R>(
        compiledQuery: CompiledQuery,
        chunkSize?: number,
    ): AsyncIterableIterator<QueryResult<R>>;
}

Index

Methods

executeQuery streamQuery

Methods

executeQuery

• executeQuery<R>(compiledQuery: CompiledQuery): Promise<QueryResult<R>>

  Type Parameters

  • R

  Parameters

  • compiledQuery: CompiledQuery

  Returns Promise<QueryResult<R>>

streamQuery

• streamQuery<R>(
      compiledQuery: CompiledQuery,
      chunkSize?: number,
  ): AsyncIterableIterator<QueryResult<R>>

  Type Parameters

  • R

  Parameters

  • compiledQuery: CompiledQuery
  • OptionalchunkSize: number

  Returns AsyncIterableIterator<QueryResult<R>>

Settings

Member Visibility

On This Page

Methods

executeQuerystreamQuery