Ready to get started?

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

Download Now

Connect to QuickBooks Data in JRuby

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

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

Configure a JDBC Connection to QuickBooks 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 QuickBooks\lib).

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

When you are connecting to a local QuickBooks instance, you do not need to set any connection properties.

Requests are made to QuickBooks through the Remote Connector. The Remote Connector runs on the same machine as QuickBooks and accepts connections through a lightweight, embedded Web server. The server supports SSL/TLS, enabling users to connect securely from remote machines.

The first time you connect, you will need to authorize the Remote Connector with QuickBooks. See the "Getting Started" chapter of the help documentation for a guide.

Built-in Connection String Designer

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

java -jar cdata.jdbc.quickbooks.jar

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

Below is a typical JDBC connection string for QuickBooks:

jdbc:quickbooks:URL=http://remotehost:8166;User=admin;Password=admin123;

Create a JRuby App with Connectivity to QuickBooks Data

Create a new Ruby file (for example: QuickBooksSelect.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 QuickBooks 2018/lib/cdata.jdbc.quickbooks.jar' url = "jdbc:quickbooks:URL=http://remotehost:8166;User=admin;Password=admin123;" conn = java.sql.DriverManager.getConnection(url) stmt = conn.createStatement rs = stmt.executeQuery("SELECT Name, CustomerBalance FROM Customers") while (rs.next) do puts rs.getString(1) + ' ' + rs.getString(2) end

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

jruby -S QuickBooksSelect.rb

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