Learn more
 

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.

In this article

Related articles

Connect to Square Data in JRuby


Create a simple JRuby app with access to live Square data.

JRuby is a high-performance, stable, fully threaded Java implementation of the Ruby programming language. The CData JDBC Driver for Square makes it easy to integrate connectivity to live Square data in JRuby. This article shows how to create a simple JRuby app that connects to Square data, executes a query, and displays the results.

Configure a JDBC Connection to Square Data

Before creating the app, note the installation location for the JAR file for the JDBC Driver (typically C:\Program Files\CData\CData JDBC Driver for Square\lib).

JRuby natively supports JDBC, so you can easily connect to Square and execute SQL queries. Initialize the JDBC connection with the getConnection function of the java.sql.DriverManager class.

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.

Below is a typical JDBC connection string for Square:

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

Create a JRuby App with Connectivity to Square Data

Create a new Ruby file (for example: SquareSelect.rb) and open it in a text editor. Copy the following code into your file:

require 'java' require 'rubygems' require 'C:/Program Files/CData/CData JDBC Driver for Square 2018/lib/cdata.jdbc.square.jar' url = "jdbc:square:OAuthClientId=MyAppId;OAuthClientSecret=MyAppSecret;CallbackURL=http://localhost:33333;LocationId=MyDefaultLocation;InitiateOAuth=GETANDREFRESH" conn = java.sql.DriverManager.getConnection(url) stmt = conn.createStatement rs = stmt.executeQuery("SELECT Reason, RefundedMoneyAmount FROM Refunds") while (rs.next) do puts rs.getString(1) + ' ' + rs.getString(2) end

With the file completed, you are ready to display your Square data with JRuby. To do so, simply run your file from the command line:

jruby -S SquareSelect.rb

Writing SQL-92 queries to Square allows you to quickly and easily incorporate Square data into your own JRuby applications. Download a free trial today!