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

Required options

TLS/SSL encryption options

Failover options

Timeout options

Pooling options

Proxy server options

Additional options

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) None
Description (n/a) None

Required options

The following table summarizes options that are required to connect to a MySQL server.

Table 2. Required options
Attribute (Short Name) Default
Database (DB) None
HostName (HOST) None
LoginID (UID) None
PortNumber (PORT) 3306
Password (PWD) None

TLS/SSL encryption options

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

Table 3. TLS/SSL encryption options
Attribute (Short Name) Default
CryptoProtocolVersion (CPV) TLSv1.2,TLSv1.1,TLSv1,SSLv3
CryptoLibName (CLN) Empty string
EnableFIPS (EF) 0 (Default provider)
EncryptionMethod (EM)

0 (No Encryption)
HostNameInCertificate (HNIC) None
KeyPassword (KP) None
Keystore (KS) None
KeystorePassword (KSP) None
SSLLibName (SLN) Empty string
Truststore (TS) None
TruststorePassword (TSP) None
ValidateServerCertificate (VSC)

1 (Enabled)

Failover options

The following table summarizes the connection options that control how failover works with the driver.
Table 4. Failover options
Attribute (Short Name) Default
AlternateServers (ASRV) None
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 5. Timeout options
Attribute (Short Name) Default
LoginTimeout (LT) 15
QueryTimeout (QT) 0

Pooling options

The following table summarizes pooling options.

Table 6. 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 7. Proxy server options
Attribute (Short Name) Default
ProxyHost (PXHN) Empty string
ProxyMode (PXM) 0(None)
ProxyPassword (PXPW) Empty string
ProxyPort (PXPT) 0
ProxyUser (PXU) Empty string

Additional options

The following table summarizes additional options.

Table 8. Additional options
Attribute (Short Name) Default
ApplicationUsingThreads (AUT) 1
BatchMechanism (BM) 2 (MultiRowInsert)
DefaultLongDataBuffLen (DLDBL) false (Disabled)
IANAAppCodePage (IACP) LINUX ONLY 4 (ISO 8559-1 Latin-1)
InteractiveClient (IC) 0 (Disabled)
ReportCodepageConversionErrors (RCCE) 0(Ignore Errors)
KeepAlive (KA) 0 (Disabled)
TreatBinaryAsChar (TBAC) 0 (Disabled)