Ready to get started?

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

 Download Now

Learn more:

Couchbase Icon Couchbase JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with Couchbase NoSQL databases.

Create a Data Access Object for Couchbase Data using JDBI

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

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

Open a Connection to Couchbase

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

To connect using the Login method, set User, Password, and Server to the credentials for the account and the address of the server you want to connect to.

Built-in Connection String Designer

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

java -jar cdata.jdbc.couchbase.jar

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

A connection string for Couchbase 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:couchbase:User=myuseraccount;Password=mypassword;Server=http://mycouchbaseserver;"); MyCustomerDAO dao =; //do stuff with the DAO dao.close();

Read Couchbase Data

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

//disply the result of our 'find' method String totalDue = dao.findTotalDueByFirstName("Bob"); System.out.println(totalDue);

Write Couchbase Data

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

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

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