Search PostgreSQL documentation

application_nameConnection ParametersWikiConnection Parameters · Session and protocolSpecifies a value for the application_name configuration parameter. Session and protocol application_name Client library libpq 10.23 Manual definition Documented Source environment fallback… authtypeConnection ParametersWikiConnection Parameters · Source-only declarationsThe matching libpq source declares the keyword authtype, but the Parameter Key Words section does not document it. Its declaration is retained as source evidence; this does not establish a s… channel_bindingConnection ParametersWikiConnection Parameters · AuthenticationThis option controls the client's use of channel binding. A setting of require means that the connection must employ channel binding, prefer means that the client will choose channel binding… client_encodingConnection ParametersWikiConnection Parameters · Session and protocolThis sets the client_encoding configuration parameter for this connection. In addition to the values accepted by the corresponding server option, you can use auto to determine the right enco… connect_timeoutConnection ParametersWikiConnection Parameters · Timeouts and keepalivesMaximum time to wait while connecting, in seconds (write as a decimal integer, e.g., 10 ). Zero, negative, or not specified means wait indefinitely. This timeout applies separately to each h… dbnameConnection ParametersWikiConnection Parameters · Connection destinationThe database name. Defaults to be the same as the user name. In certain contexts, the value is checked for extended formats; see Section 32.1.1 for more details on those. Connection destina… fallback_application_nameConnection ParametersWikiConnection Parameters · Session and protocolSpecifies a fallback value for the application_name configuration parameter. This value will be used if no value has been given for application_name via a connection parameter or the PGAPPNA… gssdelegationConnection ParametersWikiConnection Parameters · GSSAPI and KerberosForward (delegate) GSS credentials to the server. The default is 0 which means credentials will not be forwarded to the server. Set this to 1 to have credentials forwarded when possible. GS… gssencmodeConnection ParametersWikiConnection Parameters · GSSAPI and KerberosThis option determines whether or with what priority a secure GSS TCP/IP connection will be negotiated with the server. There are three modes: GSSAPI and Kerberos gssencmode Client library … gsslibConnection ParametersWikiConnection Parameters · GSSAPI and KerberosGSS library to use for GSSAPI authentication. Currently this is disregarded except on Windows builds that include both GSSAPI and SSPI support. In that case, set this to gssapi to cause libp… hostConnection ParametersWikiConnection Parameters · Connection destinationName of host to connect to. If a host name looks like an absolute path name, it specifies Unix-domain communication rather than TCP/IP communication; the value is the name of the directory i… hostaddrConnection ParametersWikiConnection Parameters · Connection destinationNumeric IP address of host to connect to. This should be in the standard IPv4 address format, e.g., 172.28.40.9 . If your machine supports IPv6, you can also use those addresses. TCP/IP comm… keepalivesConnection ParametersWikiConnection Parameters · Timeouts and keepalivesControls whether client-side TCP keepalives are used. The default value is 1, meaning on, but you can change this to 0, meaning off, if keepalives are not wanted. This parameter is ignored f… keepalives_countConnection ParametersWikiConnection Parameters · Timeouts and keepalivesControls the number of TCP keepalives that can be lost before the client's connection to the server is considered dead. A value of zero uses the system default. This parameter is ignored for… keepalives_idleConnection ParametersWikiConnection Parameters · Timeouts and keepalivesControls the number of seconds of inactivity after which TCP should send a keepalive message to the server. A value of zero uses the system default. This parameter is ignored for connections… keepalives_intervalConnection ParametersWikiConnection Parameters · Timeouts and keepalivesControls the number of seconds after which a TCP keepalive message that is not acknowledged by the server should be retransmitted. A value of zero uses the system default. This parameter is … krbsrvnameConnection ParametersWikiConnection Parameters · GSSAPI and KerberosKerberos service name to use when authenticating with GSSAPI. This must match the service name specified in the server configuration for Kerberos authentication to succeed. (See also Section… load_balance_hostsConnection ParametersWikiConnection Parameters · Connection destinationControls the order in which the client tries to connect to the available hosts and addresses. Once a connection attempt is successful no other hosts and addresses will be tried. This paramet… max_protocol_versionConnection ParametersWikiConnection Parameters · Session and protocolSpecifies the protocol version to request from the server. The default is to use version 3.0 of the PostgreSQL protocol, unless the connection string specifies a feature that relies on a hig… min_protocol_versionConnection ParametersWikiConnection Parameters · Session and protocolSpecifies the minimum protocol version to allow for the connection. The default is to allow any version of the PostgreSQL protocol supported by libpq, which currently means 3.0 . If the serv… oauth_ca_fileConnection ParametersWikiConnection Parameters · AuthenticationThe name of a file containing one or more SSL certificate authority ( CA ) certificates, which will be used to verify the identity of the authorization server and its endpoints. By default, … oauth_client_idConnection ParametersWikiConnection Parameters · AuthenticationAn OAuth 2.0 client identifier, as issued by the authorization server. If the PostgreSQL server requests an OAuth token for the connection (and if no custom OAuth hook is installed to provid… oauth_client_secretConnection ParametersWikiConnection Parameters · AuthenticationThe client password, if any, to use when contacting the OAuth authorization server. Whether this parameter is required or not is determined by the OAuth provider; "public" clients generally … oauth_issuerConnection ParametersWikiConnection Parameters · AuthenticationThe HTTPS URL of a trusted issuer to contact if the server requests an OAuth token for the connection. This parameter is required for all OAuth connections; it should exactly match the issue… oauth_scopeConnection ParametersWikiConnection Parameters · AuthenticationThe scope of the access request sent to the authorization server, specified as a (possibly empty) space-separated list of OAuth scope identifiers. This parameter is optional and intended for… optionsConnection ParametersWikiConnection Parameters · Session and protocolSpecifies command-line options to send to the server at connection start. For example, setting this to -c geqo=off or --geqo=off sets the session's value of the geqo parameter to off . Space… passfileConnection ParametersWikiConnection Parameters · AuthenticationSpecifies the name of the file used to store passwords (see Section 32.15 ). Defaults to ~/.pgpass , or %APPDATA%\postgresql\pgpass.conf on Microsoft Windows. (No error is reported if this f… passwordConnection ParametersWikiConnection Parameters · Authenticationto be used if the server demands password authentication. Authentication password Client library libpq 10.23 Manual definition Documented Source environment fallback PGPASSWORD Compiled fal… portConnection ParametersWikiConnection Parameters · Connection destinationnumber to connect to at the server host, or socket file name extension for Unix-domain connections. If multiple hosts were given in the host or hostaddr parameters, this parameter may specif… replicationConnection ParametersWikiConnection Parameters · Session and protocolThis option determines whether the connection should use the replication protocol instead of the normal protocol. This is what PostgreSQL replication connections as well as tools such as pg_… require_authConnection ParametersWikiConnection Parameters · AuthenticationSpecifies the authentication method that the client requires from the server. If the server does not use the required method to authenticate the client, or if the authentication handshake is… requirepeerConnection ParametersWikiConnection Parameters · AuthenticationThis parameter specifies the operating-system user name of the server, for example requirepeer=postgres . When making a Unix-domain socket connection, if this parameter is set, the client ch… requiresslConnection ParametersWikiConnection Parameters · TLSThis option is deprecated in favor of the sslmode setting. TLS requiressl Client library libpq 10.23 Manual definition Documented Default resolution and service-file precedence The followin… scram_client_keyConnection ParametersWikiConnection Parameters · AuthenticationThe base64-encoded SCRAM client key. This can be used by foreign-data wrappers or similar middleware to enable pass-through SCRAM authentication. See Section F.40.1.10 for one such implement… scram_server_keyConnection ParametersWikiConnection Parameters · AuthenticationThe base64-encoded SCRAM server key. This can be used by foreign-data wrappers or similar middleware to enable pass-through SCRAM authentication. See Section F.40.1.10 for one such implement… serviceConnection ParametersWikiConnection Parameters · Connection destinationname to use for additional parameters. It specifies a service name in pg_service.conf that holds additional connection parameters. This allows applications to specify only a service name so … servicefileConnection ParametersWikiConnection Parameters · Session and protocolThis option specifies the name of the per-user connection service file (see Section 32.16 ). Defaults to ~/.pg_service.conf , or %APPDATA%\postgresql\.pg_service.conf on Microsoft Windows. … ssl_max_protocol_versionConnection ParametersWikiConnection Parameters · TLSThis parameter specifies the maximum SSL/TLS protocol version to allow for the connection. Valid values are TLSv1 , TLSv1.1 , TLSv1.2 and TLSv1.3 . The supported protocols depend on the vers… ssl_min_protocol_versionConnection ParametersWikiConnection Parameters · TLSThis parameter specifies the minimum SSL/TLS protocol version to allow for the connection. Valid values are TLSv1 , TLSv1.1 , TLSv1.2 and TLSv1.3 . The supported protocols depend on the vers… sslcertConnection ParametersWikiConnection Parameters · TLSThis parameter specifies the file name of the client SSL certificate, replacing the default ~/.postgresql/postgresql.crt . This parameter is ignored if an SSL connection is not made. TLS ss…