Create a Data Access Object for Adobe Commerce Data using JDBI

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!

A brief overview of creating a SQL Object API for Adobe Commerce data in JDBI.

JDBI is a SQL convenience library for Java that exposes two different style APIs, a fluent style and a SQL object style. The CData JDBC Driver for Adobe Commerce integrates connectivity to live Adobe Commerce data in Java applications. By pairing these technologies, you gain simple, programmatic access to Adobe Commerce data. This article walks through building a basic Data Access Object (DAO) and the accompanying code to read and write Adobe Commerce data.

Create a DAO for the Adobe Commerce Products Entity

The interface below declares the desired behavior for the SQL object to create a single method for each SQL statement to be implemented.

public interface MyProductsDAO { //insert new data into Adobe Commerce @SqlUpdate("INSERT INTO Products (Style, Price) values (:style, :price)") void insert(@Bind("style") String style, @Bind("price") String price); //request specific data from Adobe Commerce (String type is used for simplicity) @SqlQuery("SELECT Price FROM Products WHERE Style = :style") String findPriceByStyle(@Bind("style") String style); /* * close with no args is used to close the connection */ void close(); }

Open a Connection to Adobe Commerce

Collect the necessary connection properties and construct the appropriate JDBC URL for connecting to Adobe Commerce.

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.

A connection string for Adobe Commerce will typically look like the following:

jdbc:adobe commerce:OAuthClientId=MyConsumerKey;OAuthClientSecret=MyConsumerSecret;CallbackURL=;Url=https://myAdobe;InitiateOAuth=GETANDREFRESH

Use the configured JDBC URL to obtain an instance of the DAO interface. The particular method shown below will open a handle bound to the instance, so the instance needs to be closed explicitly to release the handle and the bound JDBC connection.

DBI dbi = new DBI("jdbc:adobe commerce:OAuthClientId=MyConsumerKey;OAuthClientSecret=MyConsumerSecret;CallbackURL=;Url=https://myAdobe;InitiateOAuth=GETANDREFRESH"); MyProductsDAO dao =; //do stuff with the DAO dao.close();

Read Adobe Commerce Data

With the connection open to Adobe Commerce, simply call the previously defined method to retrieve data from the Products entity in Adobe Commerce.

//disply the result of our 'find' method String price = dao.findPriceByStyle("High Tech"); System.out.println(price);

Write Adobe Commerce Data

It is also simple to write data to Adobe Commerce, using the previously defined method.

//add a new entry to the Products entity dao.insert(newStyle, newPrice);

Since the JDBI library is able to work with JDBC connections, you can easily produce a SQL Object API for Adobe Commerce by integrating with the CData JDBC Driver for Adobe Commerce. Download a free trial and work with live Adobe Commerce data in custom Java applications today.