Ready to get started?

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

Download Now

Connect to Square Data in CloverDX (formerly CloverETL)

Transfer Square data using the visual workflow in the CloverDX data integration tool.

The CData JDBC Driver for Square enables you to use the data transformation components in CloverDX (formerly CloverETL) to work with Square as sources and destinations. In this article, you will use the JDBC Driver for Square to set up a simple transfer into a flat file. The CData JDBC Driver for Square enables you to use the data transformation components in CloverDX (formerly CloverETL) to work with Square as sources and destinations. In this article, you will use the JDBC Driver for Square to set up a simple transfer into a flat file.

Connect to Square as a JDBC Data Source

  1. Create the connection to Square data. In a new CloverDX graph, right-click the Connections node in the Outline pane and click Connections -> Create Connection. The Database Connection wizard is displayed.
  2. Click the plus icon to load a driver from a JAR. Browse to the lib subfolder of the installation directory and select the cdata.jdbc.square.jar file.
  3. Enter the JDBC URL.

    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.

    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.

    A typical JDBC URL is below:

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

Query Square Data with the DBInputTable Component

  1. Drag a DBInputTable from the Readers selection of the Palette onto the job flow and double-click it to open the configuration editor.
  2. In the DB connection property, select the Square JDBC data source from the drop-down menu.
  3. Enter the SQL query. For example: SELECT Reason, RefundedMoneyAmount FROM Refunds

Write the Output of the Query to a UniversalDataWriter

  1. Drag a UniversalDataWriter from the Writers selection onto the jobflow.
  2. Double-click the UniversalDataWriter to open the configuration editor and add a file URL.
  3. Right-click the DBInputTable and then click Extract Metadata.
  4. Connect the output port of the DBInputTable to the UniversalDataWriter.
  5. In the resulting Select Metadata menu for the UniversalDataWriter, choose the Refunds table. (You can also open this menu by right-clicking the input port for the UniversalDataWriter.)
  6. Click Run to write to the file.