Class MySQLConnectionManager

A ConnectionManager class specialized for MySQL.

Hierarchy

ConnectionManager<Pool>
- MySQLConnectionManager

Index

Methods

Methods

connect

connect(connOpts: ConnectionOptions): Promise<Pool>

Overrides ConnectionManager.connect
- Defined in connection/mysql-connection-manager.ts:27
Connect to the database.

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

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

end

end(): Promise<void>

Overrides ConnectionManager.end
- Defined in connection/mysql-connection-manager.ts:67
End the connection pool.

Returns Promise<void>

getConnection

getConnection(): Promise<PoolConnection>

- Defined in connection/mysql-connection-manager.ts:106
Get a single connection from the pool. (MySQL specific.)

Returns Promise<PoolConnection>

A PoolConnection instance, which is a single connection from the pool. It is the users responsibility to release() this connection using MySQLConnectionManager.release method.

getConnectionState

getConnectionState(): ConnectionStateType

Overrides ConnectionManager.getConnectionState
- Defined in connection/mysql-connection-manager.ts:86
Get the connection state.

Returns ConnectionStateType

getPool

getPool(): Pool

Overrides ConnectionManager.getPool
- Defined in connection/mysql-connection-manager.ts:93
Get the underlying connection pool object.

Returns Pool

release

release(conn: PoolConnection): void

- Defined in connection/mysql-connection-manager.ts:116
Release the connection.

Parameters
- conn: PoolConnection
Returns void

Generated using TypeDoc