Interface DatabaseConnection

A single connection to the database engine.

These are created by an instance of Driver.

interface DatabaseConnection {
    cancelQuery?(
        controlConnectionProvider: ControlConnectionProvider,
    ): Promise<void>;
    collectSessionInfo?(): Promise<void>;
    executeQuery<R>(
        compiledQuery: CompiledQuery,
        options?: AbortableOperationOptions,
    ): Promise<QueryResult<R>>;
    killSession?(
        controlConnectionProvider: ControlConnectionProvider,
    ): Promise<void>;
    streamQuery<R>(
        compiledQuery: CompiledQuery,
        chunkSize: number,
        options?: AbortableOperationOptions,
    ): AsyncIterableIterator<QueryResult<R>>;
}

Implemented by

Index

Methods

cancelQuery? collectSessionInfo? executeQuery killSession? streamQuery

Methods

`Optional`cancelQuery

cancelQuery?(
controlConnectionProvider: ControlConnectionProvider,
): Promise<void>
Used by executors to cancel the inflight query on the database side.
Parameters
- controlConnectionProvider: ControlConnectionProvider
Returns Promise<void>
- Defined in driver/database-connection.ts:13

`Optional`collectSessionInfo

collectSessionInfo?(): Promise<void>
Used by executors to prepare the connection for operations on the database side.

Returns Promise<void>
- Defined in driver/database-connection.ts:20

executeQuery

executeQuery<R>(
compiledQuery: CompiledQuery,
options?: AbortableOperationOptions,
): Promise<QueryResult<R>>
Type Parameters
- R
Parameters
- compiledQuery: CompiledQuery
- Optionaloptions: AbortableOperationOptions
Returns Promise<QueryResult<R>>
- Defined in driver/database-connection.ts:22

`Optional`killSession

killSession?(
controlConnectionProvider: ControlConnectionProvider,
): Promise<void>
Used by executors to kill the session on the database side.
Parameters
- controlConnectionProvider: ControlConnectionProvider
Returns Promise<void>
- Defined in driver/database-connection.ts:30

streamQuery

streamQuery<R>(
    compiledQuery: CompiledQuery,
    chunkSize: number,
    options?: AbortableOperationOptions,
): AsyncIterableIterator<QueryResult<R>>
Type Parameters
- R
Parameters
- compiledQuery: CompiledQuery
- chunkSize: number
- Optionaloptions: AbortableOperationOptions
Returns AsyncIterableIterator<QueryResult<R>>
- Defined in driver/database-connection.ts:34