Class PostgresConnection

A single connection to the database engine.

These are created by an instance of Driver.

Implements

DatabaseConnection

Index

Constructors

Methods

[PRIVATE_RELEASE_METHOD] cancelQuery collectSessionInfo executeQuery killSession streamQuery

Constructors

constructor

new PostgresConnection(
client: PostgresPoolClient,
options: PostgresConnectionOptions,
): PostgresConnection
Parameters
- client: PostgresPoolClient
- options: PostgresConnectionOptions
Returns PostgresConnection
- Defined in dialect/postgres/postgres-driver.ts:162

Methods

[PRIVATE_RELEASE_METHOD]

"[PRIVATE_RELEASE_METHOD]"(): void
Returns void
- Defined in dialect/postgres/postgres-driver.ts:278

cancelQuery

cancelQuery(controlConnectionProvider: ControlConnectionProvider): Promise<void>
Used by executors to cancel the inflight query on the database side.
Parameters
- controlConnectionProvider: ControlConnectionProvider
Returns Promise<void>
Implementation of DatabaseConnection.cancelQuery
- Defined in dialect/postgres/postgres-driver.ts:167

collectSessionInfo

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

Returns Promise<void>
Implementation of DatabaseConnection.collectSessionInfo
- Defined in dialect/postgres/postgres-driver.ts:176

executeQuery

executeQuery<O>(compiledQuery: CompiledQuery): Promise<QueryResult<O>>
Type Parameters
- O
Parameters
- compiledQuery: CompiledQuery
Returns Promise<QueryResult<O>>
Implementation of DatabaseConnection.executeQuery
- Defined in dialect/postgres/postgres-driver.ts:200

killSession

killSession(controlConnectionProvider: ControlConnectionProvider): Promise<void>
Used by executors to kill the session on the database side.
Parameters
- controlConnectionProvider: ControlConnectionProvider
Returns Promise<void>
Implementation of DatabaseConnection.killSession
- Defined in dialect/postgres/postgres-driver.ts:230

streamQuery

streamQuery<O>(
compiledQuery: CompiledQuery,
chunkSize: number,
): AsyncIterableIterator<QueryResult<O>>
Type Parameters
- O
Parameters
- compiledQuery: CompiledQuery
- chunkSize: number
Returns AsyncIterableIterator<QueryResult<O>>
Implementation of DatabaseConnection.streamQuery
- Defined in dialect/postgres/postgres-driver.ts:239