ODBC Driver for BigCommerce

Connection String Parameters - BigCommerce ODBC Driver

BigCommerce ODBC Connection String Parameters

The following table lists the connection string parameters for BigCommerce.

Parameter Description

API Version

Used to specify the BigCommerce API version. The choice of the API version will impact the scope of BigCommerce objects and fields available to you. Supported values:

  • Ver 2.0 (default) - BigCommerce API 2.0 will be used.
  • Ver 3.0 - BigCommerce API 3.0 will be used.


The authentication type to use when connecting to BigCommerce.

  • Basic. The default value.
  • OAuth - supports API version 2.0 and 3.0.


The HTTP address of the BigCommerce server to connect to.

User ID

Used to supply a unique User ID for connecting to a BigCommerce account.

Authentication Token

Used to supply a Legacy Token to login to BigCommerce. For information on obtaining an authentication token, see Obtaining Legacy Token. To save your authentication token in the DSN settings, select the Save Token checkbox.

Store ID

Used to identify the store you are logging into.

See Obtaining OAuth Credentials for more information.

Client ID

Used to supply a unique Client ID for your app.

Access Token

Used to supply a unique Access Token for your app. To save your access token in the DSN settings, select the Save Token checkbox.

Proxy Settings

Proxy Server

The proxy hostname or IP address.

Proxy Port

The proxy port.

Proxy User

The proxy username.

Proxy Password

The proxy password.

Advanced Settings


Some parameters don't accept null values when retrieving metadata. If a third-party tool passes a null value to such a parameter, the driver returns an error. By default, these options are enabled for compatibility with such third-party tools.


Cache Metadata This is a configurable parameter, which allows caching and storing metadata in a temporary database. The parameter settings specify the frequency of resetting cached metadata ranging from 1 hour...to 1 month.
The metadata caching is disabled.
Cached metadata is reset one time per hour.
Cached metadata is reset once a day (i.e. every 24 hours).
Cached metadata is reset once per month.
Metadata caching won't reset until the driver is unloaded.

Connection Timeout

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 expected by a third-party tool. The behavior of the ODBC driver can be changed by calling the SQLSetEnvAttr function to set the SQL_ATTR_ODBC_VERSION environment attribute. Some third-party tools expect the driver to exhibit ODBC 2.x behavior, but forget to call SQLSetEnvAttr with the needed version, or pass an incorrect value. In this case, the behavior can be explicitly set in the connection string.
The default value. ODBC behavior is determined by a third-party tool.
ODBC 2.x behavior is explicitly set.
ODBC 3.x behavior is explicitly set.


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


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


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


Use the parameter to specify whether the driver must return foreign keys. Retrieving metadata about foreign key constraints is a time-consuming operation; many third-party tools request foreign key metadata even whey they do not actually need this information. Note that enabling the parameter 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.
The driver defines the string types.
All string types are returned as SQL_CHAR, SQL_VARCHAR, and SQL_LONGVARCHAR.
All string types are returned as SQL_WCHAR, SQL_WVARCHAR, and SQL_WLONGVARCHAR.
Note: Set the parameter to Ansi or Unicode if your third-party tool supports only ANSI or Unicode strings.

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.

BigCommerce ODBC Connection String sample

DRIVER={Devart ODBC Driver for BigCommerce};Server=https://bigcommerce-store.mybigcommerce.com/api/v2/;User ID=mrsmith;Authentication Token=44jaldhr786rqws903npr1qaz9bnmp67cxzo0hfls

DRIVER={Devart ODBC Driver for BigCommerce};Authentication=OAuth;Store ID=fj4pq0s;Client ID=2tryri7ckh9dfgmn0yt3qwxcg6lvq3c;Access Token=qweabc9zcx67nbfpq54rtyuiqwexy4z

© 2015-2024 Devart. All Rights Reserved. Request Support ODBC Forum Provide Feedback