The connection option descriptions in this section 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 the option topics.

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 following tables of connection string attribute names.

Also, a few connection string attributes, for example, Password, do not have equivalent options that appear on the GUI. They are in the list of descriptions 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 the general connection options that can apply to all connections that use data sources.

Table 1. General options
Attribute (Short Name) Default
DatabaseName (db) No default value
DataSourceName (dsn) No default value
Description (n/a) No default value
Hostname (host) No default value
PortNumber (port) 27017

User ID and password authentication options

The following table summarizes the options used for user id and password authentication.

Table 2. User ID and password authentication options
Attribute (Short Name) Default
AuthenticationMethod (am) 0 (User ID and password)
AuthenticationDatabase (adb) No default value
Hostname (host) No default value
Password (pwd) No default value
User No default value

Kerberos authentication options

The following table summarizes the connection properties used for Kerberos authentication.

Table 3. Kerberos authentication options
Attribute (Short Name) Default
AuthenticationMethod (am) 0 (User ID and password)
ServicePrincipalName (spn) No default value
User No default value

LDAP authentication options

The following table summarizes the connection options used for LDAP authentication.

Table 4. LDAP authentication options
Attribute (Short Name) Default
AuthenticationMethod (am) 0 (User ID and password)
Hostname (host) No default value
Password (pwd) No default value
User No default value

Data encryption options

The following table summarizes the options used for TLS/SSL data encryption.

Table 5. Data encryption options
Attribute (Short Name) Default
CryptoProtocolVersion (cpv) No default value
EncryptionMethod (em) 0 (NoEncryption)
HostNameInCertificate (hnic) No default value
KeyPassword (kp) 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 (true)

Mapping options

The following table summarizes the connection options involved in mapping the MongoDB data model to a relational model.

Table 6. Mapping options
Attribute (Short Name) Default
ArrayNormalizationThreshold (art) 12 (elements)
ColumnDiscoverySampleSize (cdss) 1000
CreateMap (cm) 2 (NotExist)
FlattenArrayBase (fab) 1
JSONColumns (jcs) 0 (false)
KeywordConflictSuffix (kcs) No default value
LeadingUnderscoreReplacement (lusr)

None. When no value is specified, a leading underscore is used in identifiers.

LegacyVirtualKeys (lvk) 0 (false)
QualifyNormalizedNames (qnn) 1 (Table)
RefreshSchema (rs) 0 (false)
SchemaFormat (sfmt) 2 (Mixed)
SchemaMap (smp)

Default value depends on environment

SpecialCharBehavior (scb) 0 (Strip)
UppercaseIdentifiers (uci) 1 (true)

SQL engine options

The following table lists the options used to configure the SQL engine.

Table 7. SQL engine options
Attribute (Short Name) Default
BrokerIdleTimeout (bit)

600

BrokerPingInterval (bping) 30
BrokerPortNumber (bport) 1183
JVMArgs (jvma) For the 32-bit driver when the SQL Engine Mode is set to 2 (Direct) or 3 (Broker):

-Xmx256m

For all other configurations:

-Xmx1024m

JVMClassPath (jvmcp) No default value
JVMPath (jvmp) install_dir\jre\bin\java.exe
MaxConnectionsPerServer (mcps) 1024
ServerIdleTimeout (sito) 300
ServerLaunchTimeout (slt) 30
ServerPortNumber (spn)

32-bit: 19968

64-bit: 19967

SQLEngineMode (sem) For Windows:

1 (Server)

For UNIX/Linux:

The SQL engine runs in Direct mode by default.

SQLService (ss) No default value

Proxy server options

The following table summarizes the proxy server connection options.

Table 8. Proxy server options
Attribute (Short Name) Default
ProxyHost (pxhn) No default value
ProxyPassword (pxpw)

No default value

ProxyPort (pxpt)

0 which means that the default value is determined by whether the value specified for the Proxy Host (ProxyHost) option is an HTTP or HTTPS URL.

For HTTP: 80

For HTTPS: 443

ProxyUser (pxun)

No default value

Additional options

The following table summarizes additional connection options supported by the driver.

Table 9. Additional options
Attribute (Short Name) Default
ApplicationUsingThreads (aut) 1 (True)
EnableDNSLookup (edu) 1 (true)
ExtendedOptions (xo) No default value
FetchSize (fs) 100 (rows)
InitializationString (is) No default value
LogConfigFile (lgcf) ddlogging.properties
NetworkMessageCompressors (nmc) none
ReadOnly (ro) 0 (false)
ReadPreference (rp) 1 (Primary)
ReplicaSetName (rsn) No default value
ReportCodepageConversionErrors (rcce) 0 (Ignore Errors)
ResultMemorySize (rms) -1
SchemaFilter (sf)

No default value

TransactionMode (tm)

0 (NoTransactions)

VarcharThreshold (vth) 4000

This section includes the following topics: