Learn more
 

Ready to get started?

Download a free trial of the Adobe Commerce Driver to get started:

 Download Now

Learn more:

Adobe Commerce Icon Adobe Commerce JDBC Driver

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

In this article

Related articles

Connect to Adobe Commerce Data in JRuby


Create a simple JRuby app with access to live Adobe Commerce data.

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

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

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

Adobe Commerce uses the OAuth 1 authentication standard. To connect to the Adobe Commerce REST API, you will need to obtain values for the OAuthClientId, OAuthClientSecret, and CallbackURL connection properties by registering an app with your Adobe Commerce 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 Adobe Commerce system. The URL depends on whether you are using the Adobe Commerce REST API as a customer or administrator.

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

  • Administrator: To access Adobe Commerce 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 Adobe Commerce JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

java -jar cdata.jdbc.adobe commerce.jar

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

Below is a typical JDBC connection string for Adobe Commerce:

jdbc:adobe commerce:OAuthClientId=MyConsumerKey;OAuthClientSecret=MyConsumerSecret;CallbackURL=http://127.0.0.1:33333;Url=https://myAdobe Commercehost.com;InitiateOAuth=GETANDREFRESH

Create a JRuby App with Connectivity to Adobe Commerce Data

Create a new Ruby file (for example: Adobe CommerceSelect.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 Adobe Commerce 2018/lib/cdata.jdbc.adobe commerce.jar' url = "jdbc:adobe commerce:OAuthClientId=MyConsumerKey;OAuthClientSecret=MyConsumerSecret;CallbackURL=http://127.0.0.1:33333;Url=https://myAdobe Commercehost.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 Adobe Commerce data with JRuby. To do so, simply run your file from the command line:

jruby -S Adobe CommerceSelect.rb

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