Access Square Data from MySQL in Amazon QuickSight

Amazon QuickSight gives you a way to quickly build visualizations, perform analytics, and get insights from AWS data sources, uploaded files, and other databases in the cloud. When paired with the CData SQL Gateway, you get the same functionality with access to 200+ Big Data, NoSQL, and SaaS sources, both on-premises and in the cloud. In this article, we use the SQL Gateway with the CData ODBC Driver for Square to access Square data through a MySQL connection in Amazon QuickSight, either in real time using direct queries, or by importing the data into SPICE.

Connect to Square 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.

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.

When you configure the DSN, you may also want to set the Max Rows connection property. This will limit the number of rows returned, which is especially helpful for improving performance when designing reports and visualizations.

Configure the SQL Gateway

See the SQL Gateway Overview to set up connectivity to Square 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.

To connect to the SQL Gateway from QuickSight, you will need to run the SQL Gateway on a web-facing machine. After configuring the SQL Gateway, make note of the following information:

• The IP address or domain name of the machine hosting the SQL Gateway
• The data source name (likely CData Square Sys) of the MySQL service
• The port number of the MySQL service
• The credentials of a SQL Gateway user with access to the service

Configure Remote Access

If your ODBC Driver and the remoting service are installed on-premise (and not accessible from Amazon QuickSight), you can use the reverse SSH tunneling feature to enable remote access. For detailed instructions, read our Knowledge Base article: SQL Gateway SSH Tunneling Capabilities.

Connect to Square in QuickSight

Once you have a MySQL Service configured for the Square ODBC Driver, you are ready to connect to the data in QuickSight. Start by logging in to your QuickSight console. From there, click Manage Data, then click New Data Set and choose MySQL as the data source.

Configure the data set using the values for the MySQL service for Square you configured in SQL Gateway (be sure to use the DSN for the database name). Validate your connection and click Create Data Source.

Visualize Square Data in QuickSight

For this article, we will use a custom SQL query for our data visualization. To do so, click Edit/Preview Data and in the resulting Data Prep screen follow the steps below:

1. Name your data set (for example, Refunds).
2. If you wish to import your data into QuickSight SPICE, click the SPICE option, otherwise QuickSight will query the data directly.
3. Under the Tables menu, click Switch to Custom SQL Tool.
   • Give your SQL query a name.
   • Enter your custom SQL query. For example:
     SELECT Reason, RefundedMoneyAmount FROM Refunds
   • Click Finish.
4. Click Save & Visualize.

After you have saved the data set, you can configure the visualization. Select the columns you wish to visualize and choose a visual type. Your visualization can be customized, from its name to the way that data is aggregated.

With the CData ODBC Driver for Square and SQL Gateway, you are able to easily build data visualizations and perform analytics on Square data in Amazon QuickSight. If you have any questions, such as needing to access your on-premises data from AWS QuickSight, let our Support Team know.