Ready to get started?

Learn more about the CData ODBC Driver for Square or download a free trial:

Download Now

Connect to Square as an External Data Source using PolyBase

Use the CData ODBC Driver for Square and PolyBase to create an external data source in SQL Server 2019 with access to live Square data.

PolyBase for SQL Server allows you to query external data by using the same Transact-SQL syntax used to query a database table. When paired with the CData ODBC Driver for Square, you get access to your Square data directly alongside your SQL Server data. This article walks through creating an external data source and external tables to grant access to live Square data using T-SQL queries.

The CData ODBC drivers offer unmatched performance for interacting with live Square data using PolyBase due to optimized data processing built into the driver. When you issue complex SQL queries from SQL Server to Square, the driver pushes down supported SQL operations, like filters and aggregations, directly to Square and utilizes the embedded SQL engine to process unsupported operations (often SQL functions and JOIN operations) client-side. And with PolyBase, you can also join SQL Server data with Square data, using a single query to pull data from distributed sources.

Connect to Square

If you have not already, first specify connection properties in an ODBC DSN (data source name). This is the last step of the driver installation. You can use the Microsoft ODBC Data Source Administrator to create and configure ODBC DSNs. To create an external data source in SQL Server using PolyBase, configure a System DSN (CData Square Sys is created automatically).

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.

Click "Test Connection" to ensure that the DSN is connected to Square properly. Navigate to the Tables tab to review the table definitions for Square.

Create an External Data Source for Square Data

After configuring the connection, you need to create a master encryption key and a credential database for the external data source.

Creating a Master Encryption Key

Execute the following SQL command to create a new master key, 'ENCRYPTION,' to encrypt the credentials for the external data source.


Creating a Credential Database

Execute the following SQL command to create credentials for the external data source connected to Square data.

NOTE: Since Square does not require a User or Password to authenticate, you may use whatever values you wish for IDENTITY and SECRET.

WITH IDENTITY = 'username', SECRET = 'password';

Create an External Data Source for Square

Execute the following SQL command to create an external data source for Square with PolyBase, using the DSN and credentials configured earlier.

For Square, set SERVERNAME to 'localhost' or '' and leave PORT empty. PUSHDOWN is set to ON by default, meaning the ODBC Driver can leverage server-side processing for complex queries.

  CREDENTIAL = square_creds

Create External Tables for Square

After creating the external data source, use CREATE EXTERNAL TABLE statements to link to Square data from your SQL Server instance. The table column definitions must match those exposed by the CData ODBC Driver for Square. You can refer to the Tables tab of the DSN Configuration Wizard to see the table definition.

Sample CREATE TABLE Statement

The statement to create an external table based on a Square Refunds would look similar to the following:

  Reason [nvarchar](255) NULL,
  RefundedMoneyAmount [nvarchar](255) NULL,
) WITH ( 

Having created external tables for Square in your SQL Server instance, you are now able to query local and remote data simultaneously. Thanks to built-in query processing in the CData ODBC Driver, you know that as much query processing as possible is being pushed to Square, freeing up local resources and computing power. Download a free, 30-day trial of the ODBC Driver for Square and start working with live Square data alongside your SQL Server data today.