Create a Data Access Object for Magento Data using JDBI

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!

A brief overview of creating a SQL Object API for Magento 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 Magento integrates connectivity to live Magento data in Java applications. By pairing these technologies, you gain simple, programmatic access to Magento data. This article walks through building a basic Data Access Object (DAO) and the accompanying code to read and write Magento data.

Create a DAO for the Magento 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 Magento @SqlUpdate("INSERT INTO Products (Style, Price) values (:style, :price)") void insert(@Bind("style") String style, @Bind("price") String price); //request specific data from Magento (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 Magento

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

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.

A connection string for Magento will typically look like the following:


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:magento:OAuthClientId=MyConsumerKey;OAuthClientSecret=MyConsumerSecret;CallbackURL=;Url=;InitiateOAuth=GETANDREFRESH"); MyProductsDAO dao =; //do stuff with the DAO dao.close();

Read Magento Data

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

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

Write Magento Data

It is also simple to write data to Magento, 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 Magento by integrating with the CData JDBC Driver for Magento. Download a free trial and work with live Magento data in custom Java applications today.