Class ConnectorPostgres

Abstract class for creating connections to different backend providers. All implementations should extend this class and implement the following steps:

Add the provider to ./providers/.ts
Update ./factory.ts to reference the provider
Register the tag with the Provider type in ./types/provider.ts.
Create the specific provider type file at ./types/.ts
Update ./modules/utils.ts (identifyProvider) with logic to resolve the provider by inspecting the class/import

Hierarchy (view full)

AbstractConnection<PostgresClassType, PostgresClientOptions>
- ConnectorPostgres

Constructors

constructor

new ConnectorPostgres(): ConnectorPostgres
Returns ConnectorPostgres
Inherited from AbstractConnection.constructor

Properties

`Protected`connection

connection: any = null

defaultOptions

defaultOptions: PostgresClientOptions = ...

`Protected`id

id: string = null

poolClientInstance

poolClientInstance: PostgresPoolClientType

`Protected` `Static`connectionInstances

connectionInstances: Set<PostgresClientType> = ...

`Static`disconnecting

disconnecting: boolean = false

`Protected` `Static`instances

instances: Map<string, AbstractConnection<ProviderClass, ProviderOptions>> = ...

`Static`logger

logger: ILogger = ...

`Protected` `Static`poolClientInstances

poolClientInstances: Set<PostgresPoolClientType> = ...

Methods

closeConnection

closeConnection(connection): Promise<void>
Parameters
- connection: PostgresClientType
Returns Promise<void>
Overrides AbstractConnection.closeConnection
- Defined in services/connector/providers/postgres.ts:105

createConnection

createConnection(clientConstructor, options, config?): Promise<PostgresClientType>
Parameters
- clientConstructor: any
- options: PostgresClientOptions
- config: {
  connect?: boolean;
  provider?: string;
  } = {}
  - Optionalconnect?: boolean
  - Optionalprovider?: string
Returns Promise<PostgresClientType>
Overrides AbstractConnection.createConnection
- Defined in services/connector/providers/postgres.ts:32

disconnect

disconnect(): Promise<void>
Returns Promise<void>
Inherited from AbstractConnection.disconnect
- Defined in services/connector/index.ts:40

getClient

getClient(): PostgresClientType
Returns PostgresClientType
Overrides AbstractConnection.getClient
- Defined in services/connector/providers/postgres.ts:75

`Static`connect

connect<T>(this, id, client, options?, config?): Promise<T>
Type Parameters
- T extends AbstractConnection<ProviderClass, ProviderOptions, T>
Parameters
- this: (new () => T)
  - - new (): T
    - Returns T
- id: string
- client: ProviderClass
- Optionaloptions: ProviderOptions
- Optionalconfig: StringAnyType
Returns Promise<T>
Inherited from AbstractConnection.connect
- Defined in services/connector/index.ts:52

`Static`disconnectAll

disconnectAll(): Promise<void>
Returns Promise<void>
Overrides AbstractConnection.disconnectAll
- Defined in services/connector/providers/postgres.ts:82

`Static`disconnectConnections

disconnectConnections(): Promise<void>
Returns Promise<void>
- Defined in services/connector/providers/postgres.ts:98

`Static`disconnectPoolClients

disconnectPoolClients(): Promise<void>
Returns Promise<void>
- Defined in services/connector/providers/postgres.ts:91

`Static`getTransactionClient

getTransactionClient(transactionClient): Promise<["client" | "poolclient", PostgresClientType]>
Parameters
- transactionClient: any
Returns Promise<["client" | "poolclient", PostgresClientType]>
- Defined in services/connector/providers/postgres.ts:113

`Static`isPoolClient

isPoolClient(client): client is PostgresPoolClientType
Parameters
- client: any
Returns client is PostgresPoolClientType
- Defined in services/connector/providers/postgres.ts:109

Class ConnectorPostgres

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Returns ConnectorPostgres

Properties

Protectedconnection

defaultOptions

Protectedid

poolClientInstance

Protected StaticconnectionInstances

Staticdisconnecting

Protected Staticinstances

Staticlogger

Protected StaticpoolClientInstances

Methods

closeConnection

Parameters

Returns Promise<void>

createConnection

Parameters

Optionalconnect?: boolean

Optionalprovider?: string

Returns Promise<PostgresClientType>

disconnect

Returns Promise<void>

getClient

Returns PostgresClientType

Staticconnect

Type Parameters

Parameters

Returns T

Returns Promise<T>

StaticdisconnectAll

Returns Promise<void>

StaticdisconnectConnections

Returns Promise<void>

StaticdisconnectPoolClients

Returns Promise<void>

StaticgetTransactionClient

Parameters

Returns Promise<["client" | "poolclient", PostgresClientType]>

StaticisPoolClient

Parameters

Returns client is PostgresPoolClientType

Settings

On This Page

`Protected`connection

`Protected`id

`Protected` `Static`connectionInstances

`Static`disconnecting

`Protected` `Static`instances

`Static`logger

`Protected` `Static`poolClientInstances

`Optional`connect?: boolean

`Optional`provider?: string

`Static`connect

`Static`disconnectAll

`Static`disconnectConnections

`Static`disconnectPoolClients

`Static`getTransactionClient

`Static`isPoolClient