Connect to Magento Data in JRuby

Ready to get started?

Download for a free trial:

Download Now

Learn more:

Magento JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with Magento including Customers, Inventory, Products, Orders, and more!



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

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

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

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

Magento uses the OAuth 1 authentication standard. To connect to the Magento REST API, you will need to obtain values for the OAuthClientId, OAuthClientSecret, and CallbackURL connection properties by registering an app with your Magento system. See the "Getting Started" section in the help documentation for a guide to obtaining the OAuth values and connecting.

You will also need to provide the URL to your Magento system. The URL depends on whether you are using the Magento REST API as a customer or administrator.

  • Customer: To use Magento as a customer, make sure you have created a customer account in the Magento homepage. To do so, click Account -> Register. You can then set the URL connection property to the endpoint of your Magento system.

  • Administrator: To access Magento as an administrator, set CustomAdminPath instead. This value can be obtained in the Advanced settings in the Admin menu, which can be accessed by selecting System -> Configuration -> Advanced -> Admin -> Admin Base URL.

    If the Use Custom Admin Path setting on this page is set to YES, the value is inside the Custom Admin Path text box; otherwise, set the CustomAdminPath connection property to the default value, which is "admin".

Built-in Connection String Designer

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

java -jar cdata.jdbc.magento.jar

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

Below is a typical JDBC connection string for Magento:

jdbc:magento:OAuthClientId=MyConsumerKey;OAuthClientSecret=MyConsumerSecret;CallbackURL=http://127.0.0.1:33333;Url=https://mymagentohost.com;InitiateOAuth=GETANDREFRESH

Create a JRuby App with Connectivity to Magento Data

Create a new Ruby file (for example: MagentoSelect.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 Magento 2018/lib/cdata.jdbc.magento.jar' url = "jdbc:magento:OAuthClientId=MyConsumerKey;OAuthClientSecret=MyConsumerSecret;CallbackURL=http://127.0.0.1:33333;Url=https://mymagentohost.com;InitiateOAuth=GETANDREFRESH" conn = java.sql.DriverManager.getConnection(url) stmt = conn.createStatement rs = stmt.executeQuery("SELECT Name, Price FROM Products") while (rs.next) do puts rs.getString(1) + ' ' + rs.getString(2) end

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

jruby -S MagentoSelect.rb

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