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 RazorSQL

Connect to BigCommerce from wizards and query BigCommerce data from the GUI in the RazorSQL database management tool.

The CData JDBC Driver for BigCommerce enables standards-based access from third-party tools, from wizards in IDEs to data management and analysis tools. This article shows how to connect to BigCommerce using wizards in RazorSQL.

Create a JDBC Data Source for BigCommerce Data

  1. Open the RazorSQL application and, in the Connections menu, select Add Connection Profile -> Other -> JDBC.
  2. In the Connection Wizard that appears, set the following properties:
    • Driver Location: Set this property to the path to the lib subfolder in the installation directory.
    • Driver Class: Set the driver class to cdata.jdbc.bigcommerce.BigCommerceDriver.
    • Username: Enter the username. (This property can also be set in the JDBC URL.)
    • Password: Enter the password. (This property can also be set in the JDBC URL.)
    • JDBC URL: Enter connection parameters. The JDBC URL begins 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 the following:

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

Query BigCommerce Data and Select Tables

After establishing a connection, the wizard will close and the connection will be available in the connections panel. You can then query the tables.