Ready to get started?

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

Learn More

Connect to Square Data as a Federated Tables in MySQL

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

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

The CData Cloud Hub provides a pure MySQL, cloud-to-cloud interface for Square, allowing you to easily query live Square 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 Square, leveraging server-side processing to quickly return Square data.

Create a Virtual MySQL Database for Square 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 "Square" from Available Data Sources.
  3. Enter the necessary authentication properties to connect to Square.

    Square uses the OAuth authentication standard. To authenticate using OAuth, you will need to register an app with Square to obtain the OAuthClientId, OAuthClientSecret, and CallbackURL. See the "Getting Started" chapter of the help documentation for a guide to using OAuth.

    Additionally, you must specify the LocationId. You can retrieve the Ids for your Locations by querying the Locations table. Alternatively, you can set the LocationId in the search criteria of your query.

  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 Square data from any MySQL client.

Create a FEDERATED Server and Tables for Square 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 fedSquare
FOREIGN DATA WRAPPER mysql
OPTIONS (USER 'cloud_hub_user', PASSWORD 'cloud_hub_passwd', HOST 'myinstance.cdatacloud.net', PORT 3306, DATABASE 'squaredb');

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 (Refunds). Refer to the following template for the statement to create a FEDERATED table:

CREATE TABLE fed_refunds (
  ...,
  reason  TYPE(LEN),
  refundedmoneyamount  TYPE(LEN),
  ...,
)
ENGINE=FEDERATED
DEFAULT CHARSET=utf8
CONNECTION='fedSquare/Refunds';

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 Refunds to get the table schema.

Execute Queries

You can now execute queries to the Square 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 Square. Refer to the following example:

SELECT 
  fed_refunds.reason, 
  local_table.custom_field 
FROM 
  local_table 
JOIN 
  fed_refunds 
ON 
  local_table.foreign_reason = fed_refunds.reason;