Connect to X-Cart Data in JRuby

Ready to get started?

Download for a free trial:

Download Now

Learn more:

X-Cart JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with X-Cart.



Create a simple JRuby app with access to live X-Cart data.

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

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

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

An API Key must be created for your XCart Installation. In order to obtain the API Key, you need to install and configure the REST API Module for your X-Cart installation.

  • Login to your X-Cart Installation. Click on My addons on the bottom of the left side-bar navigation panel.
  • Search for REST API Module. Install the Module.
  • After the module has been installed, you need to set it up.
    • Go to the Settings section for the REST API Module.
    • On the settings page specify the API Key (only read)
  • Set the ApiKey and Url to the connection property to connect to data.

Built-in Connection String Designer

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

java -jar cdata.jdbc.xcart.jar

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

Below is a typical JDBC connection string for X-Cart:

jdbc:xcart:Url=https://example.com/shop;ApiKey=MyApiKey;

Create a JRuby App with Connectivity to X-Cart Data

Create a new Ruby file (for example: XCartSelect.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 X-Cart 2018/lib/cdata.jdbc.xcart.jar' url = "jdbc:xcart:Url=https://example.com/shop;ApiKey=MyApiKey;" conn = java.sql.DriverManager.getConnection(url) stmt = conn.createStatement rs = stmt.executeQuery("SELECT ProfileId, FirstName FROM PROFILES") while (rs.next) do puts rs.getString(1) + ' ' + rs.getString(2) end

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

jruby -S XCartSelect.rb

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