PostgresClient.Configuration.Options

Topics

Structures

• struct KeepAliveBehavior
  A keep-alive behavior for Postgres connections. The frequency defines after which time an idle connection shall run a keep-alive query.

Initializers

• init()
  Create an options structure with default values.

Instance Properties

• var additionalStartupParameters: [(String, String)]
  Additional parameters to send to the server on startup. The name value pairs are added to the initial startup message that the client sends to the server.
• var connectTimeout: Duration
  A timeout for creating a TCP/Unix domain socket connection. Defaults to 10 seconds.
• var connectionIdleTimeout: Duration
  The maximum amount of time that a connection that is not part of the minimumConnections is kept open without being leased. Defaults to 60 seconds.
• var keepAliveBehavior: PostgresClient.Configuration.Options.KeepAliveBehavior?
  The PostgresClient.Configuration.Options.KeepAliveBehavior to ensure that the underlying tcp-connection is still active for idle connections. Nil means that the client shall not run keep alive queries to the server. Defaults to a keep alive query of SELECT 1; every 30 seconds.
• var maximumConnections: Int
  The maximum number of connections that the client may open to the server at any time. Must be greater than minimumConnections. Defaults to 20 connections.
• var minimumConnections: Int
  The minimum number of connections that the client shall keep open at any time, even if there is no demand. Defaults to 0.
• var requireBackendKeyData: Bool
  Whether the connection is required to provide backend key data (internal Postgres stuff).
• var tlsServerName: String?
  The server name to use for certificate validation and SNI (Server Name Indication) when TLS is enabled. Defaults to none (but see below).