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.

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

OAuth 2.0 options

API key authentication options

SQL engine options

Proxy server options

Web service options

Additional options

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

OAuth 2.0 options

The following table summarizes options used for OAuth 2.0 authentication.

Table 2. OAuth 2.0 options
Attribute (Short Name) Default
AccessToken (atok) No default value
AuthenticationMethod (am) 24 (OAuth2)
AuthURI (o2au) No default value
ClientID (cid) No default value
ClientSecret (clse) No default value
RedirectURI (o2ru) No default value
Refresh Token No default value
Scope (oas) No default value
TokenURI (o2tu) https://api.hubapi.com/oauth/v1/token

API key authentication options

The following table summarizes options used for API key authentication.

Table 3. API key authentication options
Attribute (Short Name) Default
AuthenticationMethod (am) 24 (OAuth)
APIKey No default value

SQL engine options

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

Table 4. 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) install_dir\java\lib\hubspot.jar
JVMPath (jvmp) install_dir\jre\bin\java.exe
ServerPortNumber (spn)

32-bit: 19962

64-bit: 19961

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 5. 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 timeout.

Table 6. Web service options
Attribute (Short Name) Default
WSRetryCount (wsrc) 5
WSTimeout (wst)

120

Additional options

The following table summarizes additional connection options.

Table 7. Additional Options
Attribute (Short Name) Default
ApplicationUsingThreads (aut) 1 (true)
DebugRecord (dbgrecord) No default value
ExtendedOptions (xo) No default value
FetchSize (fs) 100 (rows)
LogConfigFile (lgcf) ddlogging.properties
ReportCodepageConversionErrors (rcce) 0

This section includes the following topics: