PostgreSQL connection using the official driver.

Implements: IReferenceable, IConfigurable, IOpenable


The PostgresConnection class allows you to create connections to PostgreSQL databases using the official driver.

Important points

  • By defining a connection and sharing it through multiple persistence components you can reduce the number of used database connections.

Configuration parameters


  • discovery_key: (optional) key to retrieve the connection from IDiscovery
  • host: host name or IP address
  • port: port number (default: 27017)
  • uri: resource URI or connection string with all parameters in it


  • store_key: (optional) key to retrieve the credentials from ICredentialStore
  • username: username
  • password: user’s password


  • connect_timeout: (optional) number of milliseconds to wait before timing out when connecting a new client (default: 0)
  • idle_timeout: (optional) number of milliseconds a client must sit idle in the pool and not be checked out (default: 10000)
  • max_pool_size: (optional) maximum number of clients the pool can contain (default: 10)


  • *:logger:*:*:1.0 - (optional) ILogger components to pass log messages
  • *:discovery:*:*:1.0 - (optional) IDiscovery services
  • *:credential-store:*:*:1.0 (optional) credential stores used to resolve credentials



The PostgreSQL connection pool object.

protected _connection: any


The connection resolver.

protected _connectionResolver: PostgresConnectionResolver


The PostgreSQL database name.

protected _databaseName: string


The logger.

protected _logger: CompositeLogger


The configuration options.

protected _options: ConfigParams

Instance methods


Closes the component and frees used resources.

public close(correlationId: string): Promise<void>

  • correlationId: string - (optional) transaction id used to trace execution through the call chain.


Configures the component by passing its configuration parameters.

public configure(config: ConfigParams): void

  • config: ConfigParams - configuration parameters to be set.


Gets a connection to a Postgres database.

public getConnection(): any

  • returns: any - connection to a Postgres database.


Gets the database name.

public getDatabaseName(): string

  • returns: string - database name