Ready to get started?

Learn more about the CData ODBC Driver for WooCommerce or download a free trial:

Download Now

Connect to WooCommerce as an External Data Source using PolyBase

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

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

Connect to WooCommerce

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

WooCommerce supports the following authentication methods: one-legged OAuth1.0 Authentication and standard OAuth2.0 Authentication.

Connecting using one-legged OAuth 1.0 Authentication

Specify the following properties (NOTE: the below credentials are generated from &service; settings page and should not be confused with the credentials generated by using WordPress OAuth2.0 plugin):

  • ConsumerKey
  • ConsumerSecret

Connecting using WordPress OAuth 2.0 Authentication

After having configured the plugin, you may connect to WooCommerce by providing the following connection properties:

  • OAuthClientId
  • OAuthClientSecret
  • CallbackURL
  • InitiateOAuth - Set this to either GETANDREFRESH or REFRESH

In either case, you will need to set the Url property to the URL of the WooCommerce instance.

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

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

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

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

Create an External Data Source for WooCommerce

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

For WooCommerce, 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_woocommerce_source
WITH ( 
  LOCATION = 'odbc://SERVERNAME[:PORT]',
  CONNECTION_OPTIONS = 'DSN=CData WooCommerce Sys',
  -- PUSHDOWN = ON | OFF,
  CREDENTIAL = woocommerce_creds
);

Create External Tables for WooCommerce

After creating the external data source, use CREATE EXTERNAL TABLE statements to link to WooCommerce data from your SQL Server instance. The table column definitions must match those exposed by the CData ODBC Driver for WooCommerce. 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 WooCommerce Orders would look similar to the following:

CREATE EXTERNAL TABLE Orders(
  ParentId [nvarchar](255) NULL,
  Total [nvarchar](255) NULL,
  ...
) WITH ( 
  LOCATION='Orders',
  DATA_SOURCE=cdata_woocommerce_source
);

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