Skip to main content

Interface: ConnectionPoolOptions

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

Properties​

minConnections?​

optional minConnections?: number

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

Minimum number of idle connections maintained in the pool.

Default​

2

maxConnections?​

optional maxConnections?: number

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

Maximum number of concurrent active connections allowed.

Default​

10

idleTimeoutMs?​

optional idleTimeoutMs?: number

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

Milliseconds after which an idle connection may be reclaimed.

Default​

30000

acquireTimeoutMs?​

optional acquireTimeoutMs?: number

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

Maximum time in milliseconds to wait when acquiring a connection before timing out.

Default​

10000

heartbeatIntervalMs?​

optional heartbeatIntervalMs?: number

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

Heartbeat interval in milliseconds for periodic database health checks. Set to 0 to disable automated background heartbeat.

Default​

30000

heartbeatQuery?​

optional heartbeatQuery?: string

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

Custom SQL query executed during heartbeat health checks. Defaults to adapter.ping() or 'SELECT 1'.