Ready to get started?

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

 Download Now

Learn more:

Apache Hbase Icon HBase JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with Apache HBase columnar databases.

Create a Data Access Object for HBase Data using JDBI

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

Create a DAO for the HBase 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 HBase @SqlUpdate("INSERT INTO Customers (ShipCity, Price) values (:shipCity, :price)") void insert(@Bind("shipCity") String shipCity, @Bind("price") String price); //request specific data from HBase (String type is used for simplicity) @SqlQuery("SELECT Price FROM Customers WHERE ShipCity = :shipCity") String findPriceByShipCity(@Bind("shipCity") String shipCity); /* * close with no args is used to close the connection */ void close(); }

Open a Connection to HBase

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

Set the Port and Server to connect to Apache HBase.

Built-in Connection String Designer

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

java -jar cdata.jdbc.apachehbase.jar

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

A connection string for HBase 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:apachehbase:Server=;Port=8080;"); MyCustomersDAO dao =; //do stuff with the DAO dao.close();

Read HBase Data

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

//disply the result of our 'find' method String price = dao.findPriceByShipCity("New York"); System.out.println(price);

Write HBase Data

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

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

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