Class ReplicationPool<Connection, ConnectionOptions>

Type Parameters

Connection extends object
ConnectionOptions extends object

Index

Constructors

Properties

#afterAcquire #beforeAcquire #timeoutErrorClass read write

Accessors

available size using waiting

Methods

acquire destroy destroyAllNow drain getPool release

Constructors

constructor

new ReplicationPool<Connection, ConnectionOptions>(config): ReplicationPool<Connection, ConnectionOptions>
Type Parameters
- Connection extends object
- ConnectionOptions extends object
Parameters
- config: ReplicationPoolConfig<Connection, ConnectionOptions>
Returns ReplicationPool<Connection, ConnectionOptions>
- Defined in packages/core/src/abstract-dialect/replication-pool.ts:88

Properties

`Private` `Readonly` #afterAcquire

#afterAcquire: undefined | ((connection, options) => Promise<void>)

Type declaration

- (connection, options): Promise<void>
- Parameters
  - connection: Connection
  - options: AcquireConnectionOptions
  Returns Promise<void>

`Private` `Readonly` #beforeAcquire

#beforeAcquire: undefined | ((options) => Promise<void>)

Type declaration

- (options): Promise<void>
- Parameters
  - options: AcquireConnectionOptions
  Returns Promise<void>

`Private` `Readonly` #timeoutErrorClass

#timeoutErrorClass: undefined | Class<TimeoutError>

`Readonly` read

read: null | Pool<Connection>

Replication read pool. Will only be used if the 'read' replication option has been provided, otherwise the write will be used instead.

`Readonly` write

write: Pool<Connection>

Accessors

available

get available(): number
Returns number
- Defined in packages/core/src/abstract-dialect/replication-pool.ts:228

size

get size(): number
Returns number
- Defined in packages/core/src/abstract-dialect/replication-pool.ts:224

using

get using(): number
Returns number
- Defined in packages/core/src/abstract-dialect/replication-pool.ts:232

waiting

get waiting(): number
Returns number
- Defined in packages/core/src/abstract-dialect/replication-pool.ts:236

Methods

acquire

acquire(options?): Promise<Connection>
Parameters
- Optional options: AcquireConnectionOptions
Returns Promise<Connection>
- Defined in packages/core/src/abstract-dialect/replication-pool.ts:158

destroy

destroy(client): Promise<void>
Parameters
- client: Connection
Returns Promise<void>
- Defined in packages/core/src/abstract-dialect/replication-pool.ts:196

destroyAllNow

destroyAllNow(): Promise<void>
Returns Promise<void>
- Defined in packages/core/src/abstract-dialect/replication-pool.ts:206

drain

drain(): Promise<void>
Returns Promise<void>
- Defined in packages/core/src/abstract-dialect/replication-pool.ts:212

getPool

getPool(poolType): Pool<Connection>
Parameters
- poolType: ConnectionType
Returns Pool<Connection>
- Defined in packages/core/src/abstract-dialect/replication-pool.ts:216

release

release(client): void
Parameters
- client: Connection
Returns void
- Defined in packages/core/src/abstract-dialect/replication-pool.ts:187