Class ConnectionManager<P>

Manages database connections.

Type parameters

P

The type of the underlying connection pool, returned from the ConnectionManager.getPool method.

Hierarchy

ConnectionManager
- MySQLConnectionManager

Index

Methods

Methods

Abstract connect

connect(connOpts: ConnectionOptions): Promise<P>

- Defined in connection/connection-manager.ts:16
Connect to the database.

Parameters
- connOpts: ConnectionOptions
  
  Connection options for setting up a connection to the database.
Returns Promise<P>

A promise that will be resolved with this underlying connection pool instance.

Abstract end

end(): Promise<void>

- Defined in connection/connection-manager.ts:21
End the connection pool.

Returns Promise<void>

Abstract getConnectionState

getConnectionState(): ConnectionStateType

- Defined in connection/connection-manager.ts:26
Get the connection state.

Returns ConnectionStateType

Abstract getPool

getPool(): P

- Defined in connection/connection-manager.ts:32
Get the underlying connection object. Its type is database flavor specific.

Returns P

Generated using TypeDoc