Learn more
 

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

In this article

Related articles

Load BigCommerce Data to a Database Using Embulk


Use CData JDBC drivers with the open source ETL/ELT tool Embulk to load BigCommerce data to a database.

Embulk is an open source bulk data loader. When paired with the CData JDBC Driver for BigCommerce, Embulk easily loads data from BigCommerce to any supported destination. In this article, we explain how to use the CData JDBC Driver for BigCommerce in Embulk to load BigCommerce data to a MySQL dtabase.

With built-in optimized data processing, the CData JDBC Driver offers unmatched performance for interacting with live BigCommerce data. When you issue complex SQL queries to BigCommerce, the driver pushes supported SQL operations, like filters and aggregations, directly to BigCommerce and utilizes the embedded SQL engine to process unsupported operations client-side (often SQL functions and JOIN operations).

Configure a JDBC Connection to BigCommerce Data

Before creating a bulk load job in Embulk, note the installation location for the JAR file for the JDBC Driver (typically C:\Program Files\CData\CData JDBC Driver for BigCommerce\lib).

Embulk supports JDBC connectivity, so you can easily connect to BigCommerce and execute SQL queries. Before creating a bulk load job, create a JDBC URL for authenticating with 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 JDBC connection string for BigCommerce:

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

Load BigCommerce Data in Embulk

After installing the CData JDBC Driver and creating a JDBC connection string, install the required Embulk plugins.

Install Embulk Input & Output Plugins

  1. Install the JDBC Input Plugin in Embulk.
    https://github.com/embulk/embulk-input-jdbc/tree/master/embulk-input-jdbc
    2. embulk gem install embulk-input-jdbc
  2. In this article, we use MySQL as the destination database. You can also choose SQL Server, PostgreSQL, or Google BigQuery as the destination using the output Plugins.
    https://github.com/embulk/embulk-output-jdbc/tree/master/embulk-output-mysql embulk gem install embulk-output-mysql

With the input and output plugins installed, we are ready to load BigCommerce data into MySQL using Embulk.

Create a Job to Load BigCommerce Data

Start by creating a config file in Embulk, using a name like bigcommerce-mysql.yml.

  1. For the input plugin options, use the CData JDBC Driver for BigCommerce, including the path to the driver JAR file, the driver class (e.g. cdata.jdbc.bigcommerce.BigCommerceDriver), and the JDBC URL from above
  2. For the output plugin options, use the values and credentials for the MySQL database

Sample Config File (bigcommerce-mysql.yml)

in: type: jdbc driver_path: C:\Program Files\CData[product_name] 20xx\lib\cdata.jdbc.bigcommerce.jar driver_class: cdata.jdbc.bigcommerce.BigCommerceDriver url: jdbc:bigcommerce:OAuthClientId=YourClientId; OAuthClientSecret=YourClientSecret; StoreId='YourStoreID'; CallbackURL='http://localhost:33333'InitiateOAuth=REFRESH table: "Customers" out: type: mysql host: localhost database: DatabaseName user: UserId password: UserPassword table: "Customers" mode: insert

After creating the file, run the Embulk job.

embulk run bigcommerce-mysql.yml

After running the the Embulk job, find the Salesforce data in the MySQL table.

Load Filtered BigCommerce Data

In addition to loading data directly from a table, you can use a custom SQL query to have more granular control of the data loaded. You can also perform increment loads by setting a last updated column in a SQL WHERE clause in the query field.

in: type: jdbc driver_path: C:\Program Files\CData[product_name] 20xx\lib\cdata.jdbc.bigcommerce.jar driver_class: cdata.jdbc.bigcommerce.BigCommerceDriver url: jdbc:bigcommerce:OAuthClientId=YourClientId; OAuthClientSecret=YourClientSecret; StoreId='YourStoreID'; CallbackURL='http://localhost:33333'InitiateOAuth=REFRESH query: "SELECT FirstName, LastName FROM Customers WHERE [RecordId] = 1" out: type: mysql host: localhost database: DatabaseName user: UserId password: UserPassword table: "Customers" mode: insert

More Information & Free Trial

By using CData JDBC Driver for BigCommerce as a connector, Embulk can integrate BigCommerce data into your data load jobs. And with drivers for more than 200+ other enterprise sources, you can integrate any enterprise SaaS, big data, or NoSQL source as well. Download a 30-day free trial and get started today.