How to connect to BigCommerce Data from IntelliJ

The CData JDBC Driver for BigCommerce enables you to access BigCommerce as a JDBC data source, providing integration with rapid development tools in IDEs. This article shows how to use the data source configuration wizard to connect to BigCommerce data in IntelliJ.

Create a JBDC Data Source for BigCommerce

Follow the steps below to add the driver JAR and define connection properties required to connect to BigCommerce data.

1. In the Data Sources window, right-click and then click Add Data Source -> DB Data Source.

2. In the Data Source Properties dialog that appears, the following properties are required:

   • JDBC Driver Files: Click the button next to this menu to add the JDBC Driver file cdata.jdbc.bigcommerce.jar, located in the installation directory.
   • JDBC Driver Class: In this menu, select cdata.jdbc.bigcommerce.BigCommerceDriver from the list.

   • Database URL: Enter the connection URL in the JDBC URL property. The URL must start with jdbc:bigcommerce: and includes connection properties separated with semicolons.

     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.

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

     A typical JDBC URL is the following:

     jdbc:bigcommerce:OAuthClientId=YourClientId; OAuthClientSecret=YourClientSecret; StoreId='YourStoreID'; CallbackURL='http://localhost:33333';InitiateOAuth=GETANDREFRESH;

Edit and Save BigCommerce Data

To discover schema information, right-click the data source you just created and click Refresh Tables. To query a table, right-click it and then click Open Tables Editor. You can also modify records in the Table Editor.