Ready to get started?

Learn more about CData Cloud Hub or sign up for a free trial:

Learn More

Connect to BigCommerce Data as a Federated Tables in MySQL

Use the CData Cloud Hub to set up federated tables for BigCommerce data in MySQL .

You can use the CData Cloud Hub to set up federated tables in MySQL for BigCommerce data. The Cloud Hub provides a MySQL interface for BigCommerce: After configuring a virtual MySQL database for BigCommerce, you can create a server and tables using the FEDERATED Storage Engine in MySQL. You can then work with BigCommerce data just as you would local MySQL tables.

The CData Cloud Hub provides a pure MySQL, cloud-to-cloud interface for BigCommerce, allowing you to easily query live BigCommerce data alongside existing MySQL data — all without replicating the data. Using optimized data processing out of the box, the CData Cloud Hub pushes all supported SQL operations (filters, JOINs, etc) directly to BigCommerce, leveraging server-side processing to quickly return BigCommerce data.

Create a Virtual MySQL Database for BigCommerce Data

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

  1. Login to Cloud Hub and click Databases.
  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 Test Database.
  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 data from any MySQL client.

Create a FEDERATED Server and Tables for BigCommerce Data

After you have configured and started the service, create a FEDERATED server to simplify the process of creating FEDERATED tables:

Create a FEDERATED Server

The following statement will create a FEDERATED server based on the Cloud Hub. Note that the username and password of the FEDERATED server must match a user account you defined on the Cloud Hub.

CREATE SERVER fedBigCommerce
FOREIGN DATA WRAPPER mysql
OPTIONS (USER 'cloud_hub_user', PASSWORD 'cloud_hub_passwd', HOST 'myinstance.cdatacloud.net', PORT 3306, DATABASE 'bigcommercedb');

Create a FEDERATED Table

To create a FEDERATED table using our newly created server, use the CONNECTION keyword and pass the name of the FEDERATED server and the remote table (Customers). Refer to the following template for the statement to create a FEDERATED table:

CREATE TABLE fed_customers (
  ...,
  firstname  TYPE(LEN),
  lastname  TYPE(LEN),
  ...,
)
ENGINE=FEDERATED
DEFAULT CHARSET=utf8
CONNECTION='fedBigCommerce/Customers';

NOTE: The table schema for the FEDERATED table must match the remote table schema exactly. You can always connect directly to the Cloud Hub using any MySQL client and run SHOW COLUMNS FROM Customers to get the table schema.

Execute Queries

You can now execute queries to the BigCommerce FEDERATED tables from any tool that can connect to MySQL, which is particularly useful if you need to JOIN data from a local table with data from BigCommerce. Refer to the following example:

SELECT 
  fed_customers.firstname, 
  local_table.custom_field 
FROM 
  local_table 
JOIN 
  fed_customers 
ON 
  local_table.foreign_firstname = fed_customers.firstname;