Connect to Magento as an External Data Source using PolyBase

Ready to get started?

Download for a free trial:

Download Now

Learn more:

Magento ODBC Driver

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

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



Use the CData ODBC Driver for Magento and PolyBase to create an external data source in SQL Server 2019 with access to live Magento 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 Magento, you get access to your Magento data directly alongside your SQL Server data. This article walks through creating an external data source and external tables to grant access to live Magento data using T-SQL queries.

The CData ODBC drivers offer unmatched performance for interacting with live Magento data using PolyBase due to optimized data processing built into the driver. When you issue complex SQL queries from SQL Server to Magento, the driver pushes down supported SQL operations, like filters and aggregations, directly to Magento 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 Magento data, using a single query to pull data from distributed sources.

Connect to Magento

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 Magento Sys is created automatically).

Magento uses the OAuth 1 authentication standard. To connect to the Magento REST API, you will need to obtain values for the OAuthClientId, OAuthClientSecret, and CallbackURL connection properties by registering an app with your Magento 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 Magento system. The URL depends on whether you are using the Magento REST API as a customer or administrator.

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

  • Administrator: To access Magento 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 Magento properly. Navigate to the Tables tab to review the table definitions for Magento.

Create an External Data Source for Magento 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 Magento data.

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

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

Create an External Data Source for Magento

Execute the following SQL command to create an external data source for Magento with PolyBase, using the DSN and credentials configured earlier.

For Magento, set SERVERNAME to 'localhost' or '127.0.0.1' and 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_magento_source
WITH ( 
  LOCATION = 'odbc://SERVERNAME[:PORT]',
  CONNECTION_OPTIONS = 'DSN=CData Magento Sys',
  -- PUSHDOWN = ON | OFF,
  CREDENTIAL = magento_creds
);

Create External Tables for Magento

After creating the external data source, use CREATE EXTERNAL TABLE statements to link to Magento data from your SQL Server instance. The table column definitions must match those exposed by the CData ODBC Driver for Magento. 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 Magento 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_magento_source
);

Having created external tables for Magento 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 Magento, freeing up local resources and computing power. Download a free, 30-day trial of the ODBC Driver for Magento and start working with live Magento data alongside your SQL Server data today.