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 general connection options that can apply to all connections that use data sources.

Table 1. General options
Attribute (Short Name) Default
DataSourceName (dsn) No default value
Description (desc) No default value
HostName (host) No default value
PortNumber (port) SSL disabled: 80

SSL enabled: 443
RESTConfigFile (rcf) No default value
RESTSamplePath (rsp) No default value

Basic (user ID and password) authentication options

The following table summarizes options used for basic authentication method.

Table 2. Basic authentication options
Attribute (Short Name) Default
AuthenticationMethod (am) 15 (None)
AuthHeader (ah) Authorization
AuthParam (ap) No default value
Password (pwd) No default value
User No default value

AWS credentials authentication options

The following table summarizes options used for AWS credentials authentication method.

Table 3. Basic authentication options
Attribute (Short Name) Default
AccessKey (ak) No default value
AuthenticationMethod (am) 15 (None)
Region No default value

If no value is specified, the driver uses us-east-1.
SecretKey (sk) No default value

Bearer token authentication options

The following table summarizes options used for bearer token authentication method.

Table 4. Bearer token authentication options
Attribute (Short Name) Default
AuthenticationMethod (am) 15 (None)
HealthURI (huri) No default value
SecurityToken (st) No default value

Custom authentication options

The following table summarizes connection options used for Custom authentication.

Table 5. Custom authentication optionss
Attribute (Short Name) Default
AuthenticationMethod (am) 15 (None)
CustomAuthParams (cap) No default value
HealthURI (huri) No default value
Password (pwd) No default value
User No default value

Digest authentication options

The following table summarizes options used for digest authentication.

Table 6. Digest authentication options
Attribute (Short Name) Default
AuthenticationMethod (am) 15 (None)
HealthURI (huri) No default value
Password (pwd) No default value
User No default value

HTTP header authentication options

The following table summarizes options used for HTTP header authentication method.

Table 7. HTTP header authentication options
Attribute (Short Name) Default
AuthenticationMethod (am) 15 (None)
AuthHeader (ah) Authorization
HealthURI (huri) No default value
SecurityToken (st) No default value

OAuth 2.0 options

The following table summarizes options used for OAuth 2.0 authentication. The OAuth 2.0 options you must specify depend on the grant type used in your environment. If you are unsure of the grant type or its requirements, contact your system administrator. For details on supported grant types, see OAuth 2.0 authentication.

Table 8. OAuth 2.0 options
Attribute (Short Name) Default
AccessToken (atok) No default value
AuthenticationMethod (am) 15 (None)
AuthURI (o2au) No default value
ClaimsIssuer (cliss)

No default value
ClaimsSubject (clsub)

No default value
ClientCredentialsMode (clcm)

0 (Default)
ClientID (cid) No default value
ClientSecret (clse) No default value
EnableLoginPrompt (elp) 0 (false)
HealthURI (huri) No default value
JWTCertAlias (jwtca) No default value
JWTCertPassword (jwtcp) No default value
JWTCertStore (jwtcs) No default value
LogoffURI (o2lu) No default value
OAuthCode (oac) No default value
RedirectURI (o2ru) No default value
RefreshToken (rtok) No default value
Scope (oas) No default value
TokenURI (o2tu) No default value

URL parameter authentication options

The following table summarizes connection options used for URL parameter authentication.

Table 9. URL parameter authentication options
Attribute (Short Name) Default
AuthenticationMethod (am) 15 (None)
AuthParam (ap) No default value
HealthURI (huri) No default value
SecurityToken (st) No default value
User No default value

TSL/SSL data encryption options

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

Table 10. TSL/SSL data encryption options
Attribute (Short Name) Default
CryptoProtocolVersion (cpv) No default value
EncryptionMethod (em) 1 (SSL)
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 connection options involved in mapping the REST data model to a SQL model.

Table 11. Mapping options
Attribute (Short Name) Default
ArrayNormalizationThreshold (art)

12
CreateMap (cm) 3 (Session)
JSONRoot (jr) No default value
QualifyNormalizedNames (qnn) 0 (No)
RefreshSchema (rs) 0 (false)
SchemaMap (smp) Default value depends on the environment

SQL engine options

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

Table 12. SQL Engine options
Attribute (Short Name) Default
JVMArgs (jvma) For the 32-bit driver when the SQL Engine Mode is set to 2 (Direct):

-Xmx256m

For all other configurations:

-Xmx1024m
JVMClassPath (jvmcp) No default value
JVMPath (jvmp) install_dir\jre\bin\java.exe
ServerPortNumber (spn)

For 32-bit: 19952

For 64-bit: 19951
ServerProxyHost (sph) No default value
ServerProxyPassword (spw) No default value
ServerProxyPort (spp) No default value
ServerProxyUser (spu) No default value
SQLEngineMode (sem) For Windows:

1 (Server)

For Linux:

2 (Direct)
SQLService (ss) No default value

Proxy server options

The following table summarizes proxy server connection options.

Table 13. 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

Web service options

The following table summarizes Web service connection options, including those related to timeouts.

Table 14. Web service options
Attribute (Short Name) Default
StmtCallLimit (scl) 0 (no limit)
StmtCallLimitBehavior (sclb) 1 (ErrorAlways)
WSFetchSize (wsfs) 2000 (rows)
WSPoolSize (wsps) 1
WSRetryCount (wsrc) 5
WSTimeout (wst) 120 (seconds)

Additional options

The following table summarizes additional connection options.

Table 15. Additional Options
Attribute (Short Name) Default
DebugRecord (dbgrecord) No default value
DefaultQueryOptions (dqo)

No default value
ExtendedOptions (xo) No default value
FetchSize (fs) 100 (rows)
LogConfigFile (lgcf) ddlogging.properties
ReadAhead (ra) 0
RefreshDirtyCache (rdc)

1 (true)
SamplingFailureTolerance (sft)

-1
Table (tbl) No default value
TransactionMode (tm) 0 (NoTransactions)
UserAgent (ua) No default value

This section includes the following topics: