Load WooCommerce Data to a Database Using Embulk

Ready to get started?

Download for a free trial:

Download Now

Learn more:

WooCommerce JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with WooCommerce Ecommerce Software



Use CData JDBC Driver for WooCommerce with the open source ETL/ELT tool Embulk to load WooCommerce data to a database.

Embulk is an open source bulk data loader. When paired with the CData JDBC Driver for WooCommerce, Embulk easily loads data from WooCommerce to any supported destination. In this article, we explain how to use the CData JDBC Driver for WooCommerce in Embulk to load WooCommerce data to a MySQL dtabase.

With built-in optimized data processing, the CData JDBC Driver offers unmatched performance for interacting with live WooCommerce data. When you issue complex SQL queries to WooCommerce, the driver pushes supported SQL operations, like filters and aggregations, directly to WooCommerce and utilizes the embedded SQL engine to process unsupported operations client-side (often SQL functions and JOIN operations).

Configure a JDBC Connection to WooCommerce Data

Before creating a bulk load job in Embulk, note the installation location for the JAR file for the JDBC Driver (typically C:\Program Files\CData\CData JDBC Driver for WooCommerce\lib).

Embulk supports JDBC connectivity, so you can easily connect to WooCommerce and execute SQL queries. Before creating a bulk load job, create a JDBC URL for authenticating with WooCommerce.

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 WooCommerce 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.

Built-in Connection String Designer

For assistance in constructing the JDBC URL, use the connection string designer built into the WooCommerce JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

java -jar cdata.jdbc.woocommerce.jar

Fill in the connection properties and copy the connection string to the clipboard.

Below is a typical JDBC connection string for WooCommerce:

jdbc:woocommerce:Url=https://example.com/; ConsumerKey=ck_ec52c76185c088ecaa3145287c8acba55a6f59ad; ConsumerSecret=cs_9fde14bf57126156701a7563fc87575713c355e5; InitiateOAuth=GETANDREFRESH

Load WooCommerce Data in Embulk

After installing the CData JDBC Driver and creating a JDBC connection string, install the required Embulk plugins.

Install Embulk Input & Output Plugins

  1. Install the JDBC Input Plugin in Embulk.
    https://github.com/embulk/embulk-input-jdbc/tree/master/embulk-input-jdbc
  2. embulk gem install embulk-input-jdbc
  3. In this article, we use MySQL as the destination database. You can also choose SQL Server, PostgreSQL, or Google BigQuery as the destination using the output Plugins.
    https://github.com/embulk/embulk-output-jdbc/tree/master/embulk-output-mysql embulk gem install embulk-output-mysql

With the input and output plugins installed, we are ready to load WooCommerce data into MySQL using Embulk.

Create a Job to Load WooCommerce Data

Start by creating a config file in Embulk, using a name like woocommerce-mysql.yml.

  1. For the input plugin options, use the CData JDBC Driver for WooCommerce, including the path to the driver JAR file, the driver class (e.g. cdata.jdbc.woocommerce.WooCommerceDriver), and the JDBC URL from above
  2. For the output plugin options, use the values and credentials for the MySQL database

Sample Config File (woocommerce-mysql.yml)

in: type: jdbc driver_path: C:\Program Files\CData\CData JDBC Driver for WooCommerce 20xx\lib\cdata.jdbc.woocommerce.jar driver_class: cdata.jdbc.woocommerce.WooCommerceDriver url: jdbc:woocommerce:Url=https://example.com/; ConsumerKey=ck_ec52c76185c088ecaa3145287c8acba55a6f59ad; ConsumerSecret=cs_9fde14bf57126156701a7563fc87575713c355e5; InitiateOAuth=REFRESH table: "Orders" out: type: mysql host: localhost database: DatabaseName user: UserId password: UserPassword table: "Orders" mode: insert

After creating the file, run the Embulk job.

embulk run woocommerce-mysql.yml

After running the the Embulk job, find the Salesforce data in the MySQL table.

Load Filtered WooCommerce Data

In addition to loading data directly from a table, you can use a custom SQL query to have more granular control of the data loaded. You can also perform increment loads by setting a last updated column in a SQL WHERE clause in the query field.

in: type: jdbc driver_path: C:\Program Files\CData\CData JDBC Driver for WooCommerce 20xx\lib\cdata.jdbc.woocommerce.jar driver_class: cdata.jdbc.woocommerce.WooCommerceDriver url: jdbc:woocommerce:Url=https://example.com/; ConsumerKey=ck_ec52c76185c088ecaa3145287c8acba55a6f59ad; ConsumerSecret=cs_9fde14bf57126156701a7563fc87575713c355e5; InitiateOAuth=REFRESH query: "SELECT ParentId, Total FROM Orders WHERE [RecordId] = 1" out: type: mysql host: localhost database: DatabaseName user: UserId password: UserPassword table: "Orders" mode: insert

More Information & Free Trial

By using CData JDBC Driver for WooCommerce as a connector, Embulk can integrate WooCommerce data into your data load jobs. And with drivers for more than 200+ other enterprise sources, you can integrate any enterprise SaaS, big data, or NoSQL source as well. Download a 30-day free trial and get started today.