Ready to get started?

Learn more about the CData JDBC Driver for BigCommerce or download a free trial:

Download Now

Connect to BigCommerce Data in DBeaver

Manage BigCommerce data with visual tools in DBeaver like the query browser.

The CData JDBC Driver for BigCommerce 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 BigCommerce data with wizards in DBeaver and browse data in the DBeaver GUI.

Create a JDBC Data Source for BigCommerce Data

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

  1. Open the DBeaver application and, in the Databases menu, select the Driver Manager option. Click New to open the Create New Driver form.
  2. In the Driver Name box, enter a user-friendly name for the driver.
  3. To add the .jar, click Add File.
  4. In the create new driver dialog that appears, select the cdata.jdbc.bigcommerce.jar file, located in the lib subfolder of the installation directory.
  5. Click the Find Class button and select the BigCommerceDriver class from the results. This will automatically fill the Class Name field at the top of the form. The class name for the driver is cdata.jdbc.bigcommerce.BigCommerceDriver.
  6. Add jdbc:bigcommerce: in the URL Template field.

Create a Connection to BigCommerce Data

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

  1. In the Databases menu, click New Connection.
  2. In the Create new connection wizard that results, select the driver.
  3. On the next page of the wizard, click the driver properties tab.
  4. Enter values for authentication credentials and other properties required to connect to BigCommerce.

    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

Query BigCommerce Data

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