How to connect to BigCommerce Data in DBVisualizer

The CData JDBC Driver for BigCommerce implements JDBC standards to provide connectivity to BigCommerce data in applications ranging from business intelligence tools to IDEs. This article shows how to establish a connection to BigCommerce data in DBVisualizer and use the table editor to edit and save BigCommerce data.

Create a New Driver Definition for BigCommerce Data

Follow the steps below to use the Driver Manager to provide connectivity to BigCommerce data from DBVisualizer tools.

1. In DBVisualizer, click Tools -> Driver Manager.
2. Click the plus sign "" to create a new driver.
3. Select "Custom" as the template.
4. On the Driver Settings tab:
   • Set Name to a user-friendly name (e.g. "CData BigCommerce Driver")
   • Set URL Format to jdbc:bigcommerce:
   • In Driver artifacts and jar files (jars are loaded in order from top):
     1. Click the plus sign "" -> "Add Files"
     2. Navigate to the "lib" folder in the installation directory (C:\Program Files\CData[product_name] XXXX\)
     3. Select the JAR file (cdata.jdbc.BigCommerce.jar) and click "Open"
5. The Driver Class should populate automatically. If not, select class (cdata.jdbc.bigcommerce.BigCommerceDriver).

Define the Connection to the JDBC Data Source

Close the "Driver Manager" and follow the steps below to save connection properties in the JDBC URL.

1. In the "Databases" tab, click the plus sign "" and select the driver you just created.

2. In the "Connection" section, set the following options:

   • Database Type: If you selected the wizard option, the database type is automatically detected. If you selected the "No Wizard" option, select the Generic or Auto Detect option in the Database Type menu.
   • Driver Type: Select the driver you just created.

   • Database URL: Enter the full JDBC URL. The syntax of the JDBC URL is jdbc:bigcommerce: followed by the connection properties in a semicolon-separated list of name-value pairs.

     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.

     When you configure the JDBC URL, you may also want to set the Max Rows connection property. This will limit the number of rows returned, which is especially helpful for improving performance when designing reports and visualizations.

     A typical connection string is below:

     jdbc:bigcommerce:OAuthClientId=YourClientId; OAuthClientSecret=YourClientSecret; StoreId='YourStoreID'; CallbackURL='http://localhost:33333'InitiateOAuth=GETANDREFRESH
   • NOTE: Since BigCommerce does not require a User or Password to authenticate, you may use whatever values you wish for Database Userid and Database Password.
3. On the Connection tab, click Connect.

To browse through tables exposed by the BigCommerce JDBC Driver, right-click a table and click "Open in New Tab."

To execute SQL queries, use the SQL Commander tool: Click SQL Commander -> New SQL Commander. Select the Database Connection, Database, and Schema from the available menus.

See the "Supported SQL" chapter in the help documentation for more information on the supported SQL. See the "Data Model" chapter for table-specific information.

More Information & Free Trial