Connect to WooCommerce Data in Aqua Data Studio

The CData JDBC Driver for WooCommerce integrates WooCommerce data with wizards and analytics in IDEs like Aqua Data Studio. This article shows how to connect to WooCommerce data through the connection manager and execute queries.

Create a JDBC Data Source

You can use the connection manager to define connection properties and save them in a new JDBC data source. The WooCommerce data source can then be accessed from Aqua Data Studio tools.

1. In Aqua Data Studio, select Register Server from the Servers menu.
2. In the Register Server form, select the 'Generic - JDBC' connection.
3. Enter the following JDBC connection properties:
   • Name: Enter a name for the data source; for example, WooCommerce.
   • Driver Location: Click the Browse button and select the cdata.jdbc.woocommerce.jar file, located in the lib subfolder of the installation directory.
   • Driver: Enter the Driver's class name, cdata.jdbc.woocommerce.WooCommerceDriver.

   • URL: Enter the JDBC URL, which starts with jdbc:woocommerce: and is followed by a semicolon-separated list of connection properties.

     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

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

     In either case, 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.

     👁 Using the built-in connection string designer to generate a JDBC URL (Salesforce is shown.)
     A typical JDBC URL is below:

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

   👁 The JDBC data source, defined by the JAR path, driver class, and JDBC URL. (QuickBooks is shown.)
   

Query WooCommerce Data

You can now query the tables exposed.