How to Connect DBeaver to WooCommerce via a JDBC Driver

The CData JDBC Driver for WooCommerce implements JDBC standards that enable third-party tools to interoperate, from wizards in IDEs to business intelligence tools. This article shows how to connect to WooCommerce data with wizards in DBeaver and browse data in the DBeaver GUI.

Create a JDBC Data Source for WooCommerce Data

Follow the steps below to load the driver JAR in DBeaver.

1. Open the DBeaver application and, in the "Database" menu, select the "Driver Manager" option. Click "New" to open the "Create new driver" form.
2. In the Settings tab:
   • Set Driver Name to a user-friendly name for the driver (e.g. CData JDBC Driver for WooCommerce).
   • Set Class Name to the class name for the JDBC driver: cdata.jdbc.woocommerce.WooCommerceDriver.
   • Set URL Template to jdbc:woocommerce:.
3. In the Libraries tab, click "Add File," navigate to the "lib" folder in the installation directory (C:\Program Files\CData[product_name] XXXX\) and select the JAR file (cdata.jdbc.WooCommerce.jar).

Create a Connection to WooCommerce Data

Follow the steps below to add credentials and other required connection properties.

1. In the "Database" menu, click "New Database Connection."
2. In the "Connect to a database" wizard that results, select the driver you just created (e.g. CData JDBC Driver for WooCommerce) and click "Next >."
3. On the Main tab of the configuration wizard, set the JDBC URL, using the required 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 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 connection string:

   jdbc:woocommerce:Url=https://example.com/; ConsumerKey=ck_ec52c76185c088ecaa3145287c8acba55a6f59ad; ConsumerSecret=cs_9fde14bf57126156701a7563fc87575713c355e5; InitiateOAuth=GETANDREFRESH
4. Click "Test Connection ..." to ensure you have configured the connection properly.
5. Click "Finish."

Query WooCommerce Data

You can now query information from the tables exposed by the connection: Right-click a Table and then click View Table. The data is available on the Data tab.

More Information & Free Trial