Ready to get started?

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

Download Now

Build Square-Connected ETL Processes in Google Data Fusion

Load the CData JDBC Driver into Google Data Fusion and create ETL processes with access live Square data.

Google Data Fusion allows users to perform self-service data integration to consolidate disparate data. Uploading the CData JDBC Driver for Square enables users to access live Square data from within their Google Data Fusion pipelines. While the CData JDBC Driver enables piping Square data to any data source natively supported in Google Data Fusion, this article walks through piping data from Square to Google BigQuery,

Upload the CData JDBC Driver for Square to Google Data Fusion

Upload the CData JDBC Driver for Square to your Google Data Fusion instance to work with live Square data. Due to the naming restrictions for JDBC drivers in Google Data Fusion, create a copy or rename the JAR file to match the following format -.jar. For example: cdata.jdbc.square-2019.jar

  1. Open your Google Data Fusion instance
  2. Click the to add an entity and upload a driver
  3. On the "Upload driver" tab, drag or browse to the renamed JAR file.
  4. On the "Driver configuration" tab:
    • Name: Create a name for the driver (cdata.jdbc.square) and make note of the name
    • Class name: Set the JDBC class name: (cdata.jdbc.square.SquareDriver)
  5. Click "Finish"

Connect to Square Data in Google Data Fusion

With the JDBC Driver uploaded, you are ready to work with live Square data in Google Data Fusion Pipelines.

  1. Navigate to the Pipeline Studio to create a new Pipeline
  2. From the "Source" options, click "Database" to add a source for the JDBC Driver
  3. Click "Properties" on the Database source to edit the properties
    • Set the Label
    • Set Reference Name to a value for any future references (i.e.: cdata-square)
    • Set Plugin Type to "jdbc"
    • Set Connection String to the JDBC URL for Square. For example:

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

      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.

      To use the JDBC Driver in Google Data Fusion, you will need to set the RTK property in the JDBC URL. You can view the licensing file included in the installation for information on how to set this property.

      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.

    • Set Import Query to a SQL query that will extract the data you want from Square, i.e.:
      SELECT * FROM Refunds
  4. From the "Sink" tab, click to add a destination sink (we use Google BigQuery in this example)
  5. Click "Properties" on the BigQuery sink to edit the properties
    • Set the Label
    • Set Reference Name to a value like square-bigquery
    • Set Project ID to a specific Google BigQuery Project ID (or leave as the default, "auto-detect")
    • Set Dataset to a specific Google BigQuery dataset
    • Set Table to the name of the table you wish to insert Square data into

With the Source and Sink configured, you are ready to pipe Square data into Google BigQuery. Save and deploy the pipeline. When you run the pipeline, Google Data Fusion will request live data from Square and import it into Google BigQuery.

While this is a simple pipeline, you can create more complex Square pipelines with transforms, analytics, conditions, and more. Download a free, 30-day trial of the CData JDBC Driver for Square and start working with your live Square data in Google Data Fusion today.