Skip to main content

Interface: IConnectionPool

Defined in: src/pool/IConnectionPool.ts:56

Methods​

acquire()​

acquire(): Promise<void>

Defined in: src/pool/IConnectionPool.ts:64

Acquires a connection lease from the pool. Waits if maximum pool capacity is reached until a connection is freed or times out.

Returns​

Promise<void>

release()​

release(): void

Defined in: src/pool/IConnectionPool.ts:69

Releases an acquired connection back to the pool.

Returns​

void

health()​

health(): Promise<PoolHealthResult>

Defined in: src/pool/IConnectionPool.ts:74

Performs an immediate health check and returns comprehensive pool diagnostics.

Returns​

Promise<PoolHealthResult>

ping()​

ping(): Promise<boolean>

Defined in: src/pool/IConnectionPool.ts:79

Pings the database and records heartbeat latency.

Returns​

Promise<boolean>

start()​

start(): Promise<void>

Defined in: src/pool/IConnectionPool.ts:84

Initializes the pool, pre-warms minConnections, and starts background heartbeat.

Returns​

Promise<void>

close()​

close(): Promise<void>

Defined in: src/pool/IConnectionPool.ts:89

Drains active connections, halts heartbeat timers, and tears down the pool.

Returns​

Promise<void>

stats()​

stats(): object

Defined in: src/pool/IConnectionPool.ts:94

Returns current connection counters.

Returns​

object

NameTypeDefined in
totalnumbersrc/pool/IConnectionPool.ts:95
activenumbersrc/pool/IConnectionPool.ts:96
idlenumbersrc/pool/IConnectionPool.ts:97
pendingnumbersrc/pool/IConnectionPool.ts:98

Properties​

options​

readonly options: Readonly<Required<ConnectionPoolOptions>>

Defined in: src/pool/IConnectionPool.ts:57

status​

readonly status: PoolStatus

Defined in: src/pool/IConnectionPool.ts:58