How to Query Square Data in MySQL Workbench

You can use the SQL Gateway from the ODBC Driver for Square to query Square data through a MySQL interface. Follow the procedure below to start the MySQL remoting service of the SQL Gateway and work with live Square data in MySQL Workbench.

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.

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.

Query Square from MySQL Workbench

The steps below outline connecting to the virtual Square database created in the SQL Gateway from MySQL Workbench and issuing basic queries to work with live Square data.

Connect to Square through the SQL Gateway

1. In MySQL Workbench, click to add a new MySQL connection.
2. Name the connection (CData SQL Gateway for Square).
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 Square Data

1. Open the connection you just created (CData SQL Gateway for Square).
2. Click File -> New Query Tab.
3. Write a SQL query to retrieve Square data, like SELECT * FROM `CData Square Sys`.Refunds;

With access to live Square data from MySQL Workbench, you can easily query and update Square, just like you would a MySQL database. Get started now with a free, 30-day trial of the CData ODBC Driver for Square and the CData SQL Gateway.