Connect to BigCommerce Data in Aqua Data Studio

The CData JDBC Driver for BigCommerce integrates BigCommerce data with wizards and analytics in IDEs like Aqua Data Studio. This article shows how to connect to BigCommerce 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 BigCommerce 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, BigCommerce.
   • Driver Location: Click the Browse button and select the cdata.jdbc.bigcommerce.jar file, located in the lib subfolder of the installation directory.
   • Driver: Enter the Driver's class name, cdata.jdbc.bigcommerce.BigCommerceDriver.

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

     BigCommerce authentication is based on the standard OAuth flow. To authenticate, you must initially create an app via the Big Commerce developer platform where you can obtain an OAuthClientId, OAuthClientSecret, and CallbackURL. These three parameters will be set as connection properties to your driver.

     Additionally, in order to connect to your BigCommerce Store, you will need your StoreId. To find your Store Id please follow these steps:

     1. Log in to your BigCommerce account.
     2. From the Home Page, select Advanced Settings > API Accounts.
     3. Click Create API Account.
     4. A text box named API Path will appear on your screen.
     5. Inside you can see a URL of the following structure: https://api.bigcommerce.com/stores/{Store Id}/v3.
     6. As demonstrated above, your Store Id will be between the 'stores/' and '/v3' path paramters.
     7. Once you have retrieved your Store Id you can either click Cancel or proceed in creating an API Account in case you do not have one already.

     Built-in Connection String Designer

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

     java -jar cdata.jdbc.bigcommerce.jar

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

     A typical JDBC URL is below:
     jdbc:bigcommerce:OAuthClientId=YourClientId; OAuthClientSecret=YourClientSecret; StoreId='YourStoreID'; CallbackURL='http://localhost:33333'InitiateOAuth=GETANDREFRESH

Query BigCommerce Data

You can now query the tables exposed.