Class: ConnectionPool
Defined in: src/pool/ConnectionPool.ts:15
Implements
Accessors
status
Get Signature
get status():
PoolStatus
Defined in: src/pool/ConnectionPool.ts:47
Returns
Implementation of
Constructors
Constructor
new ConnectionPool(
adapter,options?):ConnectionPool
Defined in: src/pool/ConnectionPool.ts:28
Parameters
| Parameter | Type |
|---|---|
adapter | IDbAdapter |
options? | ConnectionPoolOptions |
Returns
ConnectionPool
Methods
start()
start():
Promise<void>
Defined in: src/pool/ConnectionPool.ts:60
Initializes the pool, pre-warms minConnections, and starts background heartbeat.
Returns
Promise<void>
Implementation of
acquire()
acquire():
Promise<void>
Defined in: src/pool/ConnectionPool.ts:80
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>
Implementation of
release()
release():
void
Defined in: src/pool/ConnectionPool.ts:115
Releases an acquired connection back to the pool.
Returns
void
Implementation of
ping()
ping():
Promise<boolean>
Defined in: src/pool/ConnectionPool.ts:134
Pings the database and records heartbeat latency.
Returns
Promise<boolean>
Implementation of
health()
health():
Promise<PoolHealthResult>
Defined in: src/pool/ConnectionPool.ts:156
Performs an immediate health check and returns comprehensive pool diagnostics.
Returns
Promise<PoolHealthResult>
Implementation of
close()
close():
Promise<void>
Defined in: src/pool/ConnectionPool.ts:176
Drains active connections, halts heartbeat timers, and tears down the pool.
Returns
Promise<void>
Implementation of
stats()
stats():
object
Defined in: src/pool/ConnectionPool.ts:193
Returns current connection counters.
Returns
object
| Name | Type | Defined in |
|---|---|---|
total | number | src/pool/ConnectionPool.ts:194 |
active | number | src/pool/ConnectionPool.ts:195 |
idle | number | src/pool/ConnectionPool.ts:196 |
pending | number | src/pool/ConnectionPool.ts:197 |