Ready to get started?

Download a free trial of the Square Driver to get started:

 Download Now

Learn more:

Square Icon Square JDBC Driver

Easy-to-use Square client enables Java-based applications to easily consume Square Transactions, Items, Subscriptions, etc.

Integrate Square with External Services using SnapLogic



Use the CData JDBC Driver for Square in SnapLogic to integrate Square with External Services.

SnapLogic is an integration platform-as-a-service (iPaaS) that allows users to create data integration flows with no code. When paired with the CData JDBC Drivers, users get access to live data from more than 250+ SaaS, Big Data and NoSQL sources, including Square, in their SnapLogic workflows.

With built-in optimized data processing, the CData JDBC Driver offers unmatched performance for interacting with live Square data. When platforms 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 lets you work with Square data using native data types.

Connect to Square in SnapLogic

To connect to Square data in SnapLogic, download and install the CData Square JDBC Driver. Follow the installation dialog. When the installation is complete, the JAR file can be found in the installation directory (C:/Program Files/CData/CData JDBC Driver for Square/lib by default).

Upload the Square JDBC Driver

After installation, upload the JDBC JAR file to a location in SnapLogic (for example, projects/Jerod Johnson) from the Manager tab.

Configure the Connection

Once the JDBC Driver is uploaded, we can create the connection to Square.

  1. Navigate to the Designer tab
  2. Expand "JDBC" from Snaps and drag a "Generic JDBC - Select" snap onto the designer
  3. Click Add Account (or select an existing one) and click "Continue"
  4. In the next form, configure the JDBC connection properties:
    • Under JDBC JARs, add the JAR file we previously uploaded
    • Set JDBC Driver Class to cdata.jdbc.square.SquareDriver
    • Set JDBC URL to a JDBC connection string for the Square JDBC Driver, for example:

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

      NOTE: RTK is a trial or full key. Contact our Support team for more information.

      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.

  5. After entering the connection properties, click "Validate" and "Apply"

Read Square Data

In the form that opens after validating and applying the connection, configure your query.

  • Set Schema name to "Square"
  • Set Table name to a table for Square using the schema name, for example: "Square"."Refunds" (use the drop-down to see the full list of available tables)
  • Add Output fields for each item you wish to work with from the table

Save the Generic JDBC - Select snap.

With connection and query configured, click the end of the snap to preview the data (highlighted below).

Once you confirm the results are what you expect, you can add additional snaps to funnel your Square data to another endpoint.

Piping Square Data to External Services

For this article, we will load data in a Google Spreadsheet. You can use any of the supported snaps, or even use a Generic JDBC snap with another CData JDBC Driver, to move data into an external service.

  1. Start by dropping a "Worksheet Writer" snap onto the end of the "Generic JDBC - Select" snap.
  2. Add an account to connect to Google Sheets
  3. Configure the Worksheet Writer snap to write your Square data to a Google Spreadsheet

You can now execute the fully configured pipeline to extract data from Square and push it into a Google Spreadsheet.

Piping External Data to Square

As mentioned above, you can also use the JDBC Driver for Square in SnapLogic to write data to Square. Start by adding a Generic JDBC - Insert or Generic JDBC - Update snap to the dashboard.

  1. Select the existing "Account" (connection) or create a new one
  2. Configure the query:
    • Set Schema name to "Square"
    • Set Table name to a table for Square using the schema name, for example: "Square"."Refunds" (use the drop-down to see the full list of available tables)
  3. Save the Generic JDBC - Insert/Update snap

At this point, you have configured a snap to write data to Square, inserting new records or updating existing ones.

More Information & Free Trial

Using the CData JDBC Driver for Square you can create a pipeline in SnapLogic for integrating Square data with external services. For more information about connecting to Square, check at our Square connectivity page. Download a free, 30 day trial of the CData JDBC Driver for Square and get started today.