Create a Data Access Object for Cloudant Data using JDBI

Ready to get started?

Download for a free trial:

Download Now

Learn more:

Cloudant JDBC Driver

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

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

Create a DAO for the Cloudant Movies 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 MyMoviesDAO { //insert new data into Cloudant @SqlUpdate("INSERT INTO Movies (MovieRating, MovieRating) values (:movieRating, :movieRating)") void insert(@Bind("movieRating") String movieRating, @Bind("movieRating") String movieRating); //request specific data from Cloudant (String type is used for simplicity) @SqlQuery("SELECT MovieRating FROM Movies WHERE MovieRating = :movieRating") String findMovieRatingByMovieRating(@Bind("movieRating") String movieRating); /* * close with no args is used to close the connection */ void close(); }

Open a Connection to Cloudant

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

Set the following connection properties to connect to Cloudant:

  • User: Set this to your username.
  • Password: Set this to your password.

Built-in Connection String Designer

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

java -jar cdata.jdbc.cloudant.jar

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

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

jdbc:cloudant:User=abc123; Password=abcdef;

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:cloudant:User=abc123; Password=abcdef;"); MyMoviesDAO dao =; //do stuff with the DAO dao.close();

Read Cloudant Data

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

//disply the result of our 'find' method String movieRating = dao.findMovieRatingByMovieRating("R"); System.out.println(movieRating);

Write Cloudant Data

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

//add a new entry to the Movies entity dao.insert(newMovieRating, newMovieRating);

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