PostgresConnection

Inherits: IReferenceable, IConfigurable, IOpenable

Description

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

connection(s):

• 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

credential(s):

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

options:

• max_pool_size: (optional) maximum connection pool size (default: 2)
• keep_alive: (optional) enable connection keep alive (default: true)
• connect_timeout: (optional) connection timeout in milliseconds (default: 5 sec)
• auto_reconnect: (optional) enable auto reconnection (default: true)
• max_page_size: (optional) maximum page size (default: 100)
• debug: (optional) enable debug output (default: false).

References

• *: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

Fields

Instance methods

Configure

Configures the component by passing its configuration parameters.

public virtual void Configure(ConfigParams config)

• config: ConfigParams - configuration parameters to be set.

IsOpen

Checks if the component is open.

public virtual bool IsOpen()

• returns: bool - true if the component is open and false otherwise.

OpenAsync

Opens the component.

public virtual Task OpenAsync(IContext context)

• context: IContext - (optional) a context to trace execution through a call chain.

GetConnection

Gets a connection to a Postgres database.

public NpgsqlConnection GetConnection()

• returns: NpgsqlConnection - connection to a Postgres database.

GetDatabaseName

Gets the database name.

public string GetDatabaseName()

• returns: string - database’s name

SetReferences

Sets references to dependent components.

public void SetReferences(IReferences references)

• references: IReferences - references to locate the component’s dependencies.