Ready to get started?

Download a free trial of the Shopify Driver to get started:

 Download Now

Learn more:

Shopify Icon Shopify JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with Shopify Ecommerce Software

Create a Data Access Object for Shopify Data using JDBI

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

Create a DAO for the Shopify Customers 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 MyCustomersDAO { //insert new data into Shopify @SqlUpdate("INSERT INTO Customers (FirstName, Id) values (:firstName, :id)") void insert(@Bind("firstName") String firstName, @Bind("id") String id); //request specific data from Shopify (String type is used for simplicity) @SqlQuery("SELECT Id FROM Customers WHERE FirstName = :firstName") String findIdByFirstName(@Bind("firstName") String firstName); /* * close with no args is used to close the connection */ void close(); }

Open a Connection to Shopify

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

To make use of all the features of the data provider, provide the AppId, Password, and ShopUrl connection properties.

To obtain these values, see the Getting Started section in the help documentation to register the data provider as an application with Shopify.

Built-in Connection String Designer

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

java -jar cdata.jdbc.shopify.jar

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

A connection string for Shopify 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:shopify:AppId=MyAppId;Password=MyPassword;ShopUrl=;"); MyCustomersDAO dao =; //do stuff with the DAO dao.close();

Read Shopify Data

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

//disply the result of our 'find' method String id = dao.findIdByFirstName("jdoe1234"); System.out.println(id);

Write Shopify Data

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

//add a new entry to the Customers entity dao.insert(newFirstName, newId);

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