Manage BigCommerce Data in DBArtisan as a JDBC Source

The CData JDBC Driver for BigCommerce seamlessly integrates BigCommerce data into database management tools like DBArtisan by enabling you to access BigCommerce data as a database. This article shows how to create a JDBC source for BigCommerce in DBArtisan. You can then edit data visually and execute standard SQL.

Integrate BigCommerce Data into DBArtisan Projects

Follow the steps below to register BigCommerce data as a database instance in your project:

1. In DBArtisan, click Data Source -> Register Datasource.
2. Select Generic JDBC.
3. Click Manage.
4. In the resulting dialog, click New. Enter a name for the driver and click Add. In the resulting dialog, navigate to the driver JAR. The driver JAR is located in the lib subfolder of the installation directory.
5. In the Connection URL box, enter credentials and other required connection properties in the JDBC URL.

   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.

   Below is a typical connection string:

   jdbc:bigcommerce:OAuthClientId=YourClientId; OAuthClientSecret=YourClientSecret; StoreId='YourStoreID'; CallbackURL='http://localhost:33333'InitiateOAuth=GETANDREFRESH
6. Finish the wizard to connect to BigCommerce data. BigCommerce entities are displayed in the Datasource Explorer.

You can now work with BigCommerce data as you work with any other database. See the driver help documentation for more information on the queries supported by the BigCommerce API.