How to create Shopify federated tables in MySQL

You can use the SQL Gateway to configure a MySQL remoting service and set up federated tables for Shopify data. The service is a daemon process that provides a MySQL interface to the CData ODBC Driver for Shopify: After you have started the service, you can create a server and tables using the FEDERATED Storage Engine in MySQL. You can then work with Shopify data just as you would local MySQL tables.

Connect to Shopify Data

If you have not already done so, provide values for the required connection properties in the data source name (DSN). You can use the built-in Microsoft ODBC Data Source Administrator to configure the DSN. This is also the last step of the driver installation. See the "Getting Started" chapter in the help documentation for a guide to using the Microsoft ODBC Data Source Administrator to create and configure a DSN.

To make use of all the features of the data provider, provide the AppId, Password, and ShopUrl connection properties.

To obtain these values, see the Getting Started section in the help documentation to register the data provider as an application with Shopify.

Configure the SQL Gateway

See the SQL Gateway Overview to set up connectivity to Shopify data as a virtual MySQL database. You will configure a MySQL remoting service that listens for MySQL requests from clients. The service can be configured in the SQL Gateway UI.

Create a FEDERATED Server and Tables for Shopify 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 ODBC Driver for Shopify. Note that the username and password of the FEDERATED server must match a user account you defined on the Users tab of the SQL Gateway.

CREATE SERVER fedShopify
FOREIGN DATA WRAPPER mysql
OPTIONS (USER 'sql_gateway_user', PASSWORD 'sql_gateway_passwd', HOST 'sql_gateway_host', PORT ####, DATABASE 'CData Shopify Sys');

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),
  id  TYPE(LEN),
  ...,
)
ENGINE=FEDERATED
DEFAULT CHARSET=latin1
CONNECTION='fedShopify/customers';

NOTE: The table schema for the FEDERATED table must match the remote table schema exactly. You can always connect directly to the MySQL remoting service using any MySQL client and run a SHOW CREATE TABLE query to get the table schema.

Execute Queries

You can now execute queries to the Shopify 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 Shopify. 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;