Interface ReplicationPoolConfig<Connection, ConnectionOptions>

pool

readConfig

OptionaltimeoutErrorClass

writeConfig

OptionalafterAcquire

• afterAcquire?(
      connection: Connection,
      options: AcquireConnectionOptions,
  ): Promise<void>

  Parameters

  • connection: Connection
  • options: AcquireConnectionOptions

  Returns Promise<void>

OptionalbeforeAcquire

• beforeAcquire?(options: AcquireConnectionOptions): Promise<void>

  Parameters

  • options: AcquireConnectionOptions

  Returns Promise<void>

connect

• connect(
      options: ConnectionOptions,
      register: (connection: Connection) => void,
  ): Promise<Connection>

  Parameters

  • options: ConnectionOptions
  • register: (connection: Connection) => void

    Must be called with the connection as soon as it exists, and before any code that could call pool.destroy() on it (e.g. an error handler) runs — this is what lets pool.destroy() find the connection instead of throwing.

  Returns Promise<Connection>

disconnect

• disconnect(connection: Connection): Promise<void>

  Parameters

  • connection: Connection

  Returns Promise<void>

validate

• validate(connection: Connection): boolean

  Parameters

  • connection: Connection

  Returns boolean