Query BigCommerce Data in MySQL Workbench

MySQL Workbench allows users to administer MySQL environments and gain better visibility into databases. When paired with CData Connect (on-premise or Connect Server), you get live access to BigCommerce data as if it were a MySQL database. This article shows how to create a virtual database for BigCommerce in Connect and work with live BigCommerce data in MySQL Workbench.

Create a Virtual MySQL Database for BigCommerce Data

CData Connect uses a straightforward, point-and-click interface to connect to data sources and generate APIs.

1. Login to Connect and click Connections.
2. Select "BigCommerce" from Available Data Sources.
3. Enter the necessary authentication properties 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.
4. Click Save Changes
5. Click Privileges -> Add and add the new user (or an existing user) with the appropriate permissions.

With the virtual database created, you are ready to connect to BigCommerce from MySQL Workbench.

Query BigCommerce from MySQL Workbench

The steps below outline connecting to the virtual BigCommerce database in Connect from MySQL Workbench and issuing basic queries to work with live BigCommerce data.

Connect to BigCommerce through Connect

1. In MySQL Workbench, click to add a new MySQL connection.
2. Name the connection (CData Connect).
3. Set the Hostname, Port, and Username parameters to connect to the SQL Gateway.
4. Click Store in Vault to set and store the password.
5. Click Test Connection to ensure the connection is configured properly and click OK.

Query BigCommerce Data

1. Open the connection you just created (CData Connect).
2. Click File -> New Query Tab.
3. Write a SQL query to retrieve BigCommerce data, like SELECT * FROM bigcommercedb.Customers;

With access to live BigCommerce data from MySQL Workbench, you can easily query and update BigCommerce, just like you would a MySQL database. Request a demo of the CData Connect and start working with BigCommerce just like a MySQL database today.