Class AbstractConnectionManager<TConnection>`Private`

Abstract Connection Manager

Connection manager which handles pooling & replication. Uses sequelize-pool for pooling

Param: connection

Type Parameters

TConnection extends Connection = Connection

Index

Constructors

Properties

#closed #versionPromise config dialect dialectName pool sequelize

Accessors

Methods

_connect _disconnect _initDatabaseVersion _loadDialectModule _onProcessExit close connect destroyConnection disconnect getConnection releaseConnection validate

Constructors

constructor

new AbstractConnectionManager<TConnection>(dialect): AbstractConnectionManager<TConnection>
Type Parameters
- TConnection extends Connection = Connection
Parameters
- dialect: AbstractDialect
Returns AbstractConnectionManager<TConnection>
- Defined in packages/core/src/dialects/abstract/connection-manager.ts:56

Properties

`Private` #closed

#closed: boolean = false

`Private` #versionPromise

#versionPromise: null | Promise<void> = null

`Protected` `Readonly` config

config: Config

`Protected` `Readonly` dialect

dialect: AbstractDialect

`Protected` `Readonly` dialectName

dialectName: "mysql" | "postgres" | "sqlite" | "mariadb" | "mssql" | "db2" | "snowflake" | "ibmi"

`Readonly` pool

pool: ReplicationPool<TConnection>

`Protected` `Readonly` sequelize

sequelize: Sequelize

Accessors

isClosed

get isClosed(): boolean
Returns boolean
- Defined in packages/core/src/dialects/abstract/connection-manager.ts:95

Methods

`Protected` _connect

_connect(config): Promise<TConnection>
Call dialect library to get connection
Parameters
- config: ConnectionOptions
  Connection config
Returns Promise<TConnection>
- Defined in packages/core/src/dialects/abstract/connection-manager.ts:273

`Protected` _disconnect

_disconnect(connection): Promise<void>
Call dialect library to disconnect a connection
Parameters
- connection: TConnection
Returns Promise<void>
- Defined in packages/core/src/dialects/abstract/connection-manager.ts:286

_initDatabaseVersion

_initDatabaseVersion(conn?): Promise<void>
Parameters
- Optional conn: TConnection
Returns Promise<void>
- Defined in packages/core/src/dialects/abstract/connection-manager.ts:206

`Private` _loadDialectModule

_loadDialectModule(moduleName): unknown
Private
Try to load dialect module from various configured options. Priority goes like dialectModulePath > dialectModule > require(default)
Parameters
- moduleName: string
  Name of dialect module to lookup
Returns unknown
- Defined in packages/core/src/dialects/abstract/connection-manager.ts:124

_onProcessExit

_onProcessExit(): Promise<void>
Handler which executes on process exit or connection manager shutdown

Returns Promise<void>
- Defined in packages/core/src/dialects/abstract/connection-manager.ts:151

close

close(): Promise<void>
Drain the pool and close it permanently

Returns Promise<void>
- Defined in packages/core/src/dialects/abstract/connection-manager.ts:165

connect

connect(_config): Promise<TConnection>
Parameters
- _config: ConnectionOptions
Returns Promise<TConnection>
- Defined in packages/core/src/dialects/abstract/connection-manager.ts:108

destroyConnection

destroyConnection(connection): Promise<void>
Destroys a pooled connection and removes it from the pool.
Parameters
- connection: TConnection
Returns Promise<void>
- Defined in packages/core/src/dialects/abstract/connection-manager.ts:263

disconnect

disconnect(_connection): Promise<void>
Parameters
- _connection: TConnection
Returns Promise<void>
- Defined in packages/core/src/dialects/abstract/connection-manager.ts:112

getConnection

getConnection(options?): Promise<TConnection>
Get connection from pool. It sets database version if it's not already set. Call pool.acquire to get a connection.
Parameters
- Optional options: GetConnectionOptions
Returns Promise<TConnection>
- Defined in packages/core/src/dialects/abstract/connection-manager.ts:184

releaseConnection

releaseConnection(connection): void
Release a pooled connection so it can be utilized by other connection requests
Parameters
- connection: TConnection
Returns void
- Defined in packages/core/src/dialects/abstract/connection-manager.ts:253

validate

validate(_connection): boolean
Determine if a connection is still valid or not
Parameters
- _connection: TConnection
Returns boolean
- Defined in packages/core/src/dialects/abstract/connection-manager.ts:104

Generated using TypeDoc