Query Square Data in MySQL Workbench

MySQL Workbench allows users to administer MySQL environments and gain better visibility into databases. When paired with CData Connect (on-premise or Connect Server), you get live access to Square data as if it were a MySQL database. This article shows how to create a virtual database for Square in Connect and work with live Square data in MySQL Workbench.

Create a Virtual MySQL Database for Square Data

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

1. Login to Connect and click Connections.
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 Save Changes
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 from MySQL Workbench.

Query Square from MySQL Workbench

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

Connect to Square through Connect

1. In MySQL Workbench, click to add a new MySQL connection.
2. Name the connection (CData Connect).
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 Connect).
2. Click File -> New Query Tab.
3. Write a SQL query to retrieve Square data, like SELECT * FROM squaredb.Refunds;

With access to live Square data from MySQL Workbench, you can easily query and update Square, just like you would a MySQL database. Request a demo of the CData Connect and start working with Square just like a MySQL database today.