Query WooCommerce Data in DataGrip

DataGrip is a database IDE that allows SQL developers to query, create, and manage databases. When paired with the CData JDBC Driver for WooCommerce, DataGrip can work with live WooCommerce data. This article shows how to establish a connection to WooCommerce data in DataGrip and use the table editor to load WooCommerce data.

Create a New Driver Definition for WooCommerce

The steps below describe how to create a new Data Source in DataGrip for WooCommerce.

1. In DataGrip, click File -> New > Project and name the project
2. In the Database Explorer, click the plus icon () and select Driver.
3. In the Driver tab:
   • Set Name to a user-friendly name (e.g. "CData WooCommerce Driver")
   • Set Driver Files to the appropriate JAR file. To add the file, click the plus (), select "Add Files," navigate to the "lib" folder in the driver's installation directory and select the JAR file (e.g. cdata.jdbc.woocommerce.jar).
   • Set Class to cdata.jdbc.woocommerce.WooCommerce.jar
   Additionally, in the advanced tab you can change driver properties and some other settings like VM Options, VM environment, VM home path, DBMS, etc
   • For most cases, change the DBMS type to "Unknown" in Expert options to avoid native SQL Server queries (Transact-SQL), which might result in an invalid function error
4. Click "Apply" then "OK" to save the Connection

Configure a Connection to WooCommerce

1. Once the connection is saved, click the plus (), then "Data Source" then "CData WooCommerce Driver" to create a new WooCommerce Data Source.
2. In the new window, configure the connection to WooCommerce with a JDBC URL.

   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.

   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.

3. Set URL to the connection string, e.g., jdbc:woocommerce:Url=https://example.com/; ConsumerKey=ck_ec52c76185c088ecaa3145287c8acba55a6f59ad; ConsumerSecret=cs_9fde14bf57126156701a7563fc87575713c355e5; InitiateOAuth=GETANDREFRESH
4. Click "Apply" and "OK" to save the connection string

At this point, you will see the data source in the Data Explorer.

Execute SQL Queries Against WooCommerce

To browse through the WooCommerce entities (available as tables) accessible through the JDBC Driver, expand the Data Source.

To execute queries, right click on any table and select "New" -> "Query Console."

In the Console, write the SQL query you wish to execute. For example: SELECT ParentId, Total FROM Orders WHERE ParentId = '3'

Download a free, 30-day trial of the CData JDBC Driver for WooCommerce and start working with your live WooCommerce data in DataGrip. Reach out to our Support Team if you have any questions.