Connection configuration.

Configuration can be parsed from libpq-style connection strings. These strings come in two formats:

Key-Value

This format consists of space-separated key-value pairs. Values which are either the empty string or containwhitespace should be wrapped in'.' and\ characters should be backslash-escaped.

Keys

• user - The username to authenticate with. Required.
• password - The password to authenticate with.
• dbname - The name of the database to connect to. Defaults to the username.
• options - Command line options used to configure the server.
• application_name - Sets theapplication_name parameter on the server.
• sslmode - Controls usage of TLS. If set todisable, TLS will not be used. If set toprefer, TLS will be usedif available, but not used otherwise. If set torequire, TLS will be forced to be used. Defaults toprefer.
• host - The host to connect to. On Unix platforms, if the host starts with a/ character it is treated as thepath to the directory containing Unix domain sockets. Otherwise, it is treated as a hostname. Multiple hostscan be specified, separated by commas. Each host will be tried in turn when connecting. Required if connectingwith theconnect method.
• port - The port to connect to. Multiple ports can be specified, separated by commas. The number of ports must beeither 1, in which case it will be used for all hosts, or the same as the number of hosts. Defaults to 5432 ifomitted or the empty string.
• connect_timeout - The time limit in seconds applied to each socket-level connection attempt. Note that hostnamescan resolve to multiple IP addresses, and this limit is applied to each address. Defaults to no timeout.
• keepalives - Controls the use of TCP keepalive. A value of 0 disables keepalive and nonzero integers enable it.This option is ignored when connecting with Unix sockets. Defaults to on.
• keepalives_idle - The number of seconds of inactivity after which a keepalive message is sent to the server.This option is ignored when connecting with Unix sockets. Defaults to 2 hours.
• target_session_attrs - Specifies requirements of the session. If set toread-write, the client will check thatthetransaction_read_write session parameter is set toon. This can be used to connect to the primary serverin a database cluster as opposed to the secondary read-only mirrors. Defaults toall.

Examples

host=localhost user=postgres connect_timeout=10 keepalives=0

host=/var/lib/postgresql,localhost port=1234 user=postgres password='password with spaces'

host=host1,host2,host3 port=1234,,5678 user=postgres target_session_attrs=read-write

Url

This format resembles a URL with a scheme of eitherpostgres:// orpostgresql://. All components are optional,and the format accept query parameters for all of the key-value pairs described in the section above. Multiplehost/port pairs can be comma-separated. Unix socket paths in the host section of the URL should be percent-encoded,as the path component of the URL specifies the database name.

Examples

postgresql://user@localhost

postgresql://user:password@%2Fvar%2Flib%2Fpostgresql/mydb?connect_timeout=10

postgresql://user@host1:1234,host2,host3:5678?target_session_attrs=read-write

postgresql:///mydb?user=user&host=/var/lib/postgresql