Connect to Square Data in the Denodo Platform

Denodo Platform is a data virtualization product providing a single point of contact for enterprise database data. When paired with the CData JDBC Driver for Square, Denodo users can work with live Square data alongside other enterprise data sources. This article walks through creating a virtual data source for Square in the Denodo Virtual DataPort Administrator.

With built-in optimized data processing, the CData JDBC Driver offers unmatched performance for interacting with live Square data. When you issue complex SQL queries to Square, the driver pushes supported SQL operations, like filters and aggregations, directly to Square and utilizes the embedded SQL engine to process unsupported operations client-side (often SQL functions and JOIN operations). Its built-in dynamic metadata querying allows you to work with and analyze Square data using native data types.

Create the Square Virtual Port

To connect to live Square data from Denodo, you need to copy the JDBC Driver JAR file to the external library directory for Denodo and create a new JDBC Data Source from the Virtual DataPort Administrator tool.

1. Download the CData JDBC Driver for Square installer, unzip the package, and run the JAR file to install the driver.
2. Copy the JAR File (and license file if it exists) from the installation location (typically C:\Program Files\CData\CData JDBC Driver for Square\lib\) to the Denodo external library directory (C:\Denodo\Denodo Platform\lib-external\jdbc-drivers\cdata-square-19).
3. Open the Denodo Virtual DataPort Administrator tool and navigate to the Server Explorer tab.
4. Right-click "admin" and select New -> Data source -> JDBC.
5. Configure the JDBC Connection:
   • Name: your choice, e.g.: square
   • Database adapter: Generic
   • Driver class path: C:\Denodo\Denodo Platform\lib-external\jdbc-drivers\cdata-square-19
   • Driver class: cdata.jdbc.square.SquareDriver

   • Database URI: Set this to a JDBC URL using the necessary connection properties. For example,

     jdbc:square:OAuthClientId=MyAppId;OAuthClientSecret=MyAppSecret;CallbackURL=http://localhost:33333;LocationId=MyDefaultLocation;InitiateOAuth=GETANDREFRESH

     Information on creating the Database URI follows:

     Built-In Connection String Designer

     For assistance in constructing the JDBC URL, use the connection string designer built into the Square JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

     java -jar cdata.jdbc.square.jar

     Fill in the connection properties and copy the connection string to the clipboard.

     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.

6. Click the "Test connection" button to confirm the configuration and click Save.

View Square Data in the VirtualPort Administrator Tool

After creating the data source, you can create a base view of Square data for use in the Denodo Platform.

1. Click the "Create base view" button in the newly created VirtualPort (admin.Square).
2. Expand the object tree and select the objects (tables) you wish to import.
3. Click the "Create selected" button to create views of the Square data.
   Optional: Click "Create associations from foreign keys" to define relationships between the objects.
4. With the view(s) created, navigate to a table (cdata_square_refunds) in the Server Explorer and double-click the selected table.
5. In the new tab, click "Execution panel" to open a query panel.
6. Customize the query in the "Execute" tab or use the default:

   SELECT * FROM cdata_square_refunds CONTEXT ('i18n'='us_est', 'cache_wait_for_load'='true')
   

7. Click Execute to view the data.

With the base view created, you can now work with live Square data like you would any other data source in Denodo Platform, for example, querying Square in the Denodo Data Catalog.

Download a free, 30-day trial of the CData JDBC Driver for Square and start working with your live Square data in Denodo Platform. Reach out to our Support Team if you have any questions.