Ready to get started?

Download a free trial of the Adobe Commerce ODBC Driver to get started:

 Download Now

Learn more:

Adobe Commerce Icon Adobe Commerce ODBC Driver

The Adobe Commerce ODBC Driver is a powerful tool that allows you to connect with live Adobe Commerce data, directly from any applications that support ODBC connectivity.

Access Adobe Commerce like you would a database - read, write, and update Customers, Inventory, Products, Orders, etc. through a standard ODBC Driver interface.

How to connect PolyBase to Adobe Commerce



Use the CData ODBC Driver for Adobe Commerce and PolyBase to create an external data source in SQL Server 2019 with access to live Adobe Commerce data.

PolyBase for SQL Server allows you to query external data by using the same Transact-SQL syntax used to query a database table. When paired with the CData ODBC Driver for Adobe Commerce, you get access to your Adobe Commerce data directly alongside your SQL Server data. This article describes creating an external data source and external tables to grant access to live Adobe Commerce data using T-SQL queries.

NOTE: PolyBase is only available on SQL Server 19 and above, and only for Standard SQL Server.

The CData ODBC drivers offer unmatched performance for interacting with live Adobe Commerce data using PolyBase due to optimized data processing built into the driver. When you issue complex SQL queries from SQL Server to Adobe Commerce, the driver pushes down supported SQL operations, like filters and aggregations, directly to Adobe Commerce and utilizes the embedded SQL engine to process unsupported operations (often SQL functions and JOIN operations) client-side. And with PolyBase, you can also join SQL Server data with Adobe Commerce data, using a single query to pull data from distributed sources.

Connect to Adobe Commerce

If you have not already, first specify connection properties in an ODBC DSN (data source name). This is the last step of the driver installation. You can use the Microsoft ODBC Data Source Administrator to create and configure ODBC DSNs. To create an external data source in SQL Server using PolyBase, configure a System DSN (CData Adobe Commerce Sys is created automatically).

Adobe Commerce uses the OAuth 1 authentication standard. To connect to the Adobe Commerce REST API, you will need to obtain values for the OAuthClientId, OAuthClientSecret, and CallbackURL connection properties by registering an app with your Adobe Commerce system. See the "Getting Started" section in the help documentation for a guide to obtaining the OAuth values and connecting.

You will also need to provide the URL to your Adobe Commerce system. The URL depends on whether you are using the Adobe Commerce REST API as a customer or administrator.

  • Customer: To use Adobe Commerce as a customer, make sure you have created a customer account in the Adobe Commerce homepage. To do so, click Account -> Register. You can then set the URL connection property to the endpoint of your Adobe Commerce system.

  • Administrator: To access Adobe Commerce as an administrator, set CustomAdminPath instead. This value can be obtained in the Advanced settings in the Admin menu, which can be accessed by selecting System -> Configuration -> Advanced -> Admin -> Admin Base URL.

    If the Use Custom Admin Path setting on this page is set to YES, the value is inside the Custom Admin Path text box; otherwise, set the CustomAdminPath connection property to the default value, which is "admin".

Click "Test Connection" to ensure that the DSN is connected to Adobe Commerce properly. Navigate to the Tables tab to review the table definitions for Adobe Commerce.

Create an External Data Source for Adobe Commerce Data

After configuring the connection, you need to create a master encryption key and a credential database for the external data source.

Creating a Master Encryption Key

Execute the following SQL command to create a new master key, 'ENCRYPTION,' to encrypt the credentials for the external data source.

CREATE MASTER KEY ENCRYPTION BY PASSWORD = 'password';

Creating a Credential Database

Execute the following SQL command to create credentials for the external data source connected to Adobe Commerce data.

NOTE: Since Adobe Commerce does not require a User or Password to authenticate, you may use whatever values you wish for IDENTITY and SECRET.


CREATE DATABASE SCOPED CREDENTIAL adobe commerce_creds
WITH IDENTITY = 'username', SECRET = 'password';

Create an External Data Source for Adobe Commerce

Execute a CREATE EXTERNAL DATA SOURCE SQL command to create an external data source for Adobe Commerce with PolyBase:

  • Set the LOCATION parameter , using the DSN and credentials configured earlier.

For Adobe Commerce, set SERVERNAME to the URL or address for your server (e.g. 'localhost' or '127.0.0.1' for local servers; the remote URL for remote servers). Leave PORT empty. PUSHDOWN is set to ON by default, meaning the ODBC Driver can leverage server-side processing for complex queries.


CREATE EXTERNAL DATA SOURCE cdata_adobe commerce_source
WITH ( 
  LOCATION = 'odbc://SERVER_URL',
  CONNECTION_OPTIONS = 'DSN=CData Adobe Commerce Sys',
  -- PUSHDOWN = ON | OFF,
  CREDENTIAL = adobe commerce_creds
);

Create External Tables for Adobe Commerce

After creating the external data source, use CREATE EXTERNAL TABLE statements to link to Adobe Commerce data from your SQL Server instance. The table column definitions must match those exposed by the CData ODBC Driver for Adobe Commerce. You can refer to the Tables tab of the DSN Configuration Wizard to see the table definition.

Sample CREATE TABLE Statement

The statement to create an external table based on a Adobe Commerce Products would look similar to the following:

CREATE EXTERNAL TABLE Products(
  Name [nvarchar](255) NULL,
  Price [nvarchar](255) NULL,
  ...
) WITH ( 
  LOCATION='Products',
  DATA_SOURCE=cdata_adobe commerce_source
);

Having created external tables for Adobe Commerce in your SQL Server instance, you are now able to query local and remote data simultaneously. Thanks to built-in query processing in the CData ODBC Driver, you know that as much query processing as possible is being pushed to Adobe Commerce, freeing up local resources and computing power. Download a free, 30-day trial of the ODBC Driver for Adobe Commerce and start working with live Adobe Commerce data alongside your SQL Server data today.