Interface ReplicationPoolConfig<Connection, ConnectionOptions>

interface ReplicationPoolConfig<
    Connection extends object,
    ConnectionOptions extends object,
> {
    pool: ReplicationPoolOptions;
    readConfig: null | readonly ConnectionOptions[];
    timeoutErrorClass?: Class<Error>;
    writeConfig: ConnectionOptions;
    afterAcquire(
        connection: Connection,
        options: AcquireConnectionOptions,
    ): Promise<void>;
    beforeAcquire(options: AcquireConnectionOptions): Promise<void>;
    connect(options: ConnectionOptions): Promise<Connection>;
    disconnect(connection: Connection): Promise<void>;
    validate(connection: Connection): boolean;
}

Type Parameters

Connection extends object
ConnectionOptions extends object

Index

Properties

pool readConfig timeoutErrorClass? writeConfig

Methods

afterAcquire? beforeAcquire? connect disconnect validate

Properties

pool

pool: ReplicationPoolOptions

readConfig

readConfig: null | readonly ConnectionOptions[]

`Optional`timeoutErrorClass

timeoutErrorClass?: Class<Error>

writeConfig

writeConfig: ConnectionOptions

Methods

`Optional`afterAcquire

afterAcquire(
connection: Connection,
options: AcquireConnectionOptions,
): Promise<void>
Parameters
- connection: Connection
- options: AcquireConnectionOptions
Returns Promise<void>
- Defined in packages/core/src/abstract-dialect/replication-pool.ts:69

`Optional`beforeAcquire

beforeAcquire(options: AcquireConnectionOptions): Promise<void>
Parameters
- options: AcquireConnectionOptions
Returns Promise<void>
- Defined in packages/core/src/abstract-dialect/replication-pool.ts:68

connect

connect(options: ConnectionOptions): Promise<Connection>
Parameters
- options: ConnectionOptions
Returns Promise<Connection>
- Defined in packages/core/src/abstract-dialect/replication-pool.ts:62

disconnect

disconnect(connection: Connection): Promise<void>
Parameters
- connection: Connection
Returns Promise<void>
- Defined in packages/core/src/abstract-dialect/replication-pool.ts:64

validate

validate(connection: Connection): boolean
Parameters
- connection: Connection
Returns boolean
- Defined in packages/core/src/abstract-dialect/replication-pool.ts:66