Ready to get started?

Download a free trial of the BigCommerce Driver to get started:

 Download Now

Learn more:

BigCommerce Icon BigCommerce JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with BigCommerce Ecommerce Software

Connect to BigCommerce Data in NetBeans



Connect to BigCommerce data in NetBeans with the data source configuration wizard.

The CData JDBC Driver for BigCommerce integrates connectivity to live BigCommerce data in IDEs that support JDBC. The JDBC standard enables you to use built-in data access wizards and other tools supporting rapid development. This article shows how to connect to BigCommerce data in NetBeans. You will create a connection and edit and save BigCommerce data in the Table Editor.

Create a JDBC Data Source for BigCommerce in NetBeans

To create the JDBC data source, expand the Database node in the Service window, right-click the Drivers node, and select New Driver. In the New Driver wizard that results, enter the following information:

  • Driver File(s): Click Add and, in the file explorer dialog that appears, select the cdata.jdbc.bigcommerce.jar file. The driver JAR is located in the lib subfolder of the installation directory.
  • Driver Class: Click Find to search for the driver class inside the JAR. Then select cdata.jdbc.bigcommerce.BigCommerceDriver from the menu.
  • Name: Enter the name for the driver.

Define Connection Parameters

Follow the steps below to define required connection properties:

  1. In the Service window, right-click the Database node and click New Connection.

  2. In the New Connection Wizard, enter the following connection properties:

    • Driver Name: In the menu, select the CData JDBC Driver for BigCommerce.
    • User Name: Enter the username. This can also be defined in the JDBC URL.
    • Password: Enter the password. This can also be defined in the JDBC URL.
    • JDBC URL: Specify 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.

      A typical JDBC URL is the following:

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

Query BigCommerce Data

To connect to BigCommerce data, right-click the connection in the Database node and click Connect. After the connection is established, you can expand it to discover schema information.

To load a table in the Data Views window, right-click the table and then click View Data. You can also insert, update, or delete records in the Data Views window.