Class ConnectionPool

Connection Pool class Manages a pool of database connections with configurable limits

Hierarchy (View Summary)

EventEmitter
- ConnectionPool
  - DatabaseConnectionPool

Index

Constructors

Properties

connections _size _available _inUse _acquired _released _destroyed _pending

Accessors

max min pending stats size available inUse isDestroyed used

Methods

initialize getConnection releaseConnection destroyConnection destroy createConnection

Constructors

constructor

new ConnectionPool(config: PoolConfig): ConnectionPool
Constructor
Parameters
- config: PoolConfig
Returns ConnectionPool
Overrides EventEmitter.constructor
- Defined in connection-pool.ts:289

Properties

`Protected`connections

connections: Map<string, PooledConnection> = ...

`Protected`_size

_size: number = 0

`Protected`_available

_available: number = 0

`Protected`_inUse

_inUse: number = 0

`Protected`_acquired

_acquired: number = 0

`Protected`_released

_released: number = 0

`Protected`_destroyed

_destroyed: number = 0

`Protected`_pending

_pending: number = 0

Accessors

max

get max(): number
Maximum number of connections in the pool

Returns number
- Defined in connection-pool.ts:268

min

get min(): number
Minimum number of idle connections

Returns number
- Defined in connection-pool.ts:275

pending

get pending(): number
Get the pending requests count

Returns number
- Defined in connection-pool.ts:282

stats

get stats(): {
    size: number;
    available: number;
    inUse: number;
    acquired: number;
    released: number;
    destroyed: number;
    pending: number;
}
Get pool statistics

Returns {
    size: number;
    available: number;
    inUse: number;
    acquired: number;
    released: number;
    destroyed: number;
    pending: number;
}
- Defined in connection-pool.ts:556

size

get size(): number
Get the current pool size

Returns number
- Defined in connection-pool.ts:571

available

get available(): number
Get the number of available connections

Returns number
- Defined in connection-pool.ts:578

inUse

get inUse(): number
Get the number of connections in use

Returns number
- Defined in connection-pool.ts:585

isDestroyed

get isDestroyed(): boolean
Check if the pool is destroyed

Returns boolean
- Defined in connection-pool.ts:592

used

get used(): number
Get the number of connections in use (alias for inUse)

Returns number
- Defined in connection-pool.ts:599

Methods

initialize

initialize(): Promise<void>
Initialize the pool with a factory function to create connections

Returns Promise<void>
- Defined in connection-pool.ts:308

getConnection

getConnection(): Promise<PooledConnection>
Get a connection from the pool

Returns Promise<PooledConnection>
- Defined in connection-pool.ts:322

releaseConnection

releaseConnection(pooledConnection: PooledConnection): void
Release a connection back to the pool
Parameters
- pooledConnection: PooledConnection
Returns void
- Defined in connection-pool.ts:410

destroyConnection

destroyConnection(pooledConnection: PooledConnection): Promise<void>
Destroy a connection
Parameters
- pooledConnection: PooledConnection
Returns Promise<void>
- Defined in connection-pool.ts:456

destroy

destroy(connection?: any): Promise<void>
Destroy a specific connection or the entire pool
Parameters
- Optionalconnection: any
  Optional connection to destroy. If not provided, destroys the entire pool
Returns Promise<void>
- Defined in connection-pool.ts:506

`Protected`createConnection

createConnection(): Promise<PooledConnection>
Create a new connection

Returns Promise<PooledConnection>
- Defined in connection-pool.ts:618