The following connection option descriptions are listed alphabetically by the GUI name that appears on the driver Setup dialog box. The connection string attribute name, along with its short name, is listed immediately underneath the GUI name.

In most cases, the GUI name and the attribute name are the same; however, some exceptions exist. If you need to look up an option by its connection string attribute name, please refer to the alphabetical table of connection string attribute names.

Also, a few connection string attributes do not have equivalent options that appear on the GUI. They are in the list of descriptions alphabetically by their attribute names.

Note: The driver does not support specifying values for the same connection option multiple times in a connection string or DSN. If a value is specified using the same attribute multiple times or using both long and short attributes, the connection may fail or the driver may not behave as intended.

The following tables provide a summary of supported connection options by functionality, including their attribute names, short names, and default values.

General options

The following table summarizes general options that can apply to all connections that use data sources.

Table 1. General options
Attribute (Short Name) Default
DataSourceName (DSN) No default value
Database (DB) No default value
Description (n/a) No default value
HostName (HOST) No default value
PortNumber (PORT) 5432

User ID/password options

The following table summarizes options that are required for user ID/password authentication.

Table 2. User ID/password options
Attribute (Short Name) Default
AuthenticationMethod (AM) 0
LogonID (UID) No default value
Password (PWD) No default value

Kerberos authentication options

The following table summarizes options that are required for Kerberos authentication.

Table 3. Kerberos authentication options
Attribute (Short Name) Default
AuthenticationMethod (AM) 0
GSSClient (GSSC) native
ServicePrincipalName (SPN) No default value

Certificate-based authentication options

The following table summarizes the connection options used for certificate-based authentication.

Table 4. Certificate-based authentication options
Attribute (Short Name) Default
AuthenticationMethod (AM) 0
ClientSSLCertificate (CSC) No default value
ClientSSLKey (CSK) No default value
HostNameInCertificate (HNIC) No default value
Keystore (KS) No default value
KeystorePassword (KSP) No default value
Truststore (TS) No default value
TruststorePassword (TSP) No default value
ValidateServerCertificate (VSC) 1 (Enabled)

Entra ID using user ID and password authentication options

The following table summarizes options that are required for Entra ID authentication using user ID and password authentication.

Table 5. Entra ID using user id and password authentication options
Attribute (Short Name) Default
AuthenticationMethod (AM) 0
LoginID (UID) No default value
Password (PWD) No default value

Entra ID using service principal authentication options

The following table summarizes options that are required for Entra ID authentication using service principal.

Table 6. Entra ID using service principal authentication options
Attribute (Short Name) Default
AuthenticationMethod (AM) 0
AzureTenantID (ATID) No default value
LoginID (UID) No default value
Password (PWD) No default value

TLS/SSL encryption options

The following table summarizes the connection options used to enable TLS/SSL.

Table 7. TLS/SSL encryption options
Attribute (Short Name) Default
CryptoProtocolVersion (CPV) TLSv1.3,TLSv1.2
CryptoLibName (CLN) No default value
EnableFIPS (EF) 0 (Default provider)
EncryptionMethod (EM) 0 (No Encryption)
HostNameInCertificate (HNIC) No default value
KeyPassword (KP) No default value
Keystore (KS) No default value
KeystorePassword (KSP) No default value
OpenSSLConfigFile (OSSLCNF)

install_dir\drivers\openssl.cnf (Windows)

install_dir/lib/openssl.cnf (UNIX/Linux)

OpenSSLProviderPath (OSSLPP)

install_dir\drivers (Windows)

install_dir/lib (UNIX/Linux)

SSLLibName (SLN) No default value
Truststore (TS) No default value
TruststorePassword (TSP) No default value
ValidateServerCertificate (VSC) 1 (Enabled)

Failover options

The following table summarizes the connection options that control how failover works with the driver.
Table 8. Failover options
Attribute (Short Name) Default
AlternateServers (ASRV) No default value
ConnectionRetryCount (CRC) 0
ConnectionRetryDelay (CRD) 3
FailoverGranularity (FG) 0 (Non-Atomic)
FailoverMode (FM)

0 (Connection)

FailoverPreconnect (FP) 0 (Disabled)
LoadBalancing (LB) 0 (Disabled)

Timeout options

The following table summarizes timeout options.

Table 9. Timeout options
Attribute (Short Name) Default
LoginTimeout (LT) 15
QueryTimeout (QT) 0

Pooling options

The following table summarizes pooling options.

Table 10. Pooling options
Attribute (Short Name) Default
ConnectionReset (CR) 0 (Disabled)
LoadBalanceTimeout (LBT) 0 (Disabled)
MaxPoolSize (MXPS) 100
MinPoolSize (MNPS) 0
Pooling (POOL) 0 (Disabled)

Proxy server options

The following table summarizes proxy server options.

Table 11. Proxy server options
Attribute (Short Name) Default
ProxyHost (PXHN) No default value
ProxyMode (PXM) 0 (None)
ProxyPassword (PXPW) No default value
ProxyPort (PXPT) 0
ProxyUser (PXU) No default value

Additional options

The following table summarizes additional options.

Table 12. Additional options
Attribute (Short Name) Default
ApplicationUsingThreads (AUT) 1
BatchMechanism (BM) 3 (Copy)
CallEscapeBehavior (CEB) 2
EnableKeysetCursors (EKC) 0 (Disabled)
EnableDescribeParam (EDP) 1 (Enabled)
ExtendedColumnMetaData (ECMD) 0 (Disabled)
ExtendedOptions (XO) No default value
FetchRefCursor (FRC) 1 (Enabled)
FetchSize (FS) 50000
FetchTSWTZasTimestamp (FTSWTZAT) 0 (Disabled)
FetchTWFSasTime (FTWFSAT) 0 (Disabled)
IANAAppCodePage (IACP) LINUX ONLY 4 (ISO 8559-1 Latin-1)
InitializationString (IS) No default value
KeepAlive (KA) 0 (Disabled)
KeysetCursorOptions (KCO) 0 (RowID Columns)
MaxCharSize (MCS) No default value
MaxLongVarcharSize (MLVS) No default value
MaxVarcharSize (MVS) No default value
ReportCodepageConversionErrors (RCCE) 0 (Ignore Errors)
ShowSelectableTables (SST) 1 (Enabled)
TransactionErrorBehavior (TEB) 1 (Rollback Transaction)
UnboundedNumericPrecision (UNP) -1
UnboundedNumericScale (UNS) -1
UseDeclareFetch (UDF) 0 (Disabled)
XMLDescribeType (XDT) -10