Connection String Parameters - ODBC Driver for ShipStation

API Version

Specifies the API protocol version used for the connection. The possible values are:

• Ver1 - Uses API Version 1 (default).
• Ver2 - Uses API Version 2.

API Key

Specifies the first part of the REST API key used to connect to ShipStation.

Secret Key

Specifies the second part of the REST API key used to connect to ShipStation.

Production Key

Specifies the REST API production key used to connect to ShipStation.

Proxy Settings

Proxy Server

Specifies the proxy hostname or IP address.

Proxy User ID

Specifies the proxy server account ID.

Proxy Password

Specifies the proxy password.

Proxy Port

Specifies the port number used to connect to a proxy server.

Advanced Settings

Allow NULL strings

Enables compatibility with third-party tools that pass NULL to metadata retrieval parameters. According to MSDN, not all of these parameters accept NULL, and the driver should return an error if NULL is passed.

Empty strings as NULL

Connection Timeout

Specifies the time (in seconds) to wait for a connection to open before terminating an attempt. The default value is 60.

ODBC Behavior

Sets the behavior corresponding to the ODBC specification version that a third-party tool expects. The behavior of ODBC driver can be changed by setting a value for the SQL_ATTR_ODBC_VERSION attribute by calling the SQLSetEnvAttr function. But some third-party tools expect the driver to exhibit ODBC 2.x behavior, but forget to call SQLSetEnvAttr with the specified version or pass an incorrect value there. In this case, the required behavior can be explicitly specified in the Connection String by setting the ODBC Behavior parameter. The possible values are:

• Default - default ODBC behavior determined by a third-party tool.
• Ver 2.x - ODBC 2.x behavior is explicitly set.
• Ver 3.x - ODBC 3.x behavior is explicitly set.

RegionalNumberSettings

Enables the use of local regional settings when converting numbers to strings.

RegionalDateTimeSettings

Enables the use of local regional settings when converting dates and times to strings.

ReturnForeignKeys

Specifies whether the driver returns foreign keys. Retrieving metadata about foreign key constraints is a time-consuming operation; many third-party tools request foreign key metadata even when they do not actually need this information. Note that enabling the option may degrade performance of data access operations. The default value is False.

String Types

Sets the string value types returned by the driver as Default, Ansi or Unicode.

• Default - the driver defines the string types.
• Ansi - all string types will be returned as SQL_CHAR, SQL_VARCHAR and SQL_LONGVARCHAR.
• Unicode - all string types will be returned as SQL_WCHAR, SQL_WVARCHAR and SQL_WLONGVARCHAR.

The parameter value should be changed if any third-party tool supports only Ansi string types or Unicode ones.

QueryTimeout

Specifies the time to wait for a query execution result before terminating and generating an error.

UTC Dates

Specifies whether all the datetime values retrieved from the data source are returned as UTC values or converted to local time and whether the date values specified on the application side (e.g., in SQL statements) are considered UTC or local. The default value is false.