ODBC Driver for Adobe Commerce

Connection String Parameters - ODBC Driver for Adobe Commerce


Adobe Commerce ODBC Connection String Parameters

The following table lists the connection string parameters for Adobe Commerce (formerly Magento).

Parameter Description

Version

Used to specify the required Adobe Commerce version. The available values are:

  • Ver1
  • Ver2

The default value is Ver1.

Magento 1.x:

Domain

The URL of your Magento store admin panel.

User ID

Magento API user login.

Note: API users and keys are created and configured individually in Magento admin panel: see the Creating Magento API User. To save your authentication token in the DSN settings, select the Save Token checkbox.

API Key

API Key is used for secure authorization of API users to Magento store.

Adobe Commerce or Magento 2.x:

Domain

The URL of your Adobe Commerce or Magento store admin panel.

User ID

Magento API user login.

Note: API users and keys are created and configured individually in Adobe Commerce or Magento admin panel: see the Create Magento API User.

Password

Password is used for secure authorization of users to Adobe Commerce or Magento store.

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

AllowNullStringsInMetadata

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.

EmptyStringsAsNullInMetadata
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.
False
The metadata caching is disabled.
Hour
Cached metadata is reset one time per hour.
Day
Cached metadata is reset once a day (i.e. every 24 hours).
Month
Cached metadata is reset once per month.
True
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.
0
The default value. ODBC behavior is determined by a third-party tool.
2
ODBC 2.x behavior is explicitly set.
3
ODBC 3.x behavior is explicitly set.

QueryTimeout

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

RegionalDateTimeSettings

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

RegionalNumberSettings

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

ReturnForeignKeys

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 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 are returned as SQL_CHAR, SQL_VARCHAR, and SQL_LONGVARCHAR.
Unicode
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.

Sample Magento Version 1.x ODBC Connection String

DRIVER={Devart ODBC Driver for for Adobe Commerce};Domain=http://myhost/magento;User ID=admin;Api Key=admin11111

Sample Adobe Commerce or Magento Version 2.x ODBC Connection String

DRIVER={Devart ODBC Driver for Adobe Commerce};Version=Ver2;Domain=http://myhost/magento;User ID=admin;Password=admin111

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