Create a Data Access Object for IBM Cloud SQL Query Data using JDBI

Ready to get started?

Download for a free trial:

Download Now

Learn more:

IBM Cloud SQL Query JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with IBM Cloud SQL Query.

In this article

Related articles


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

Create a DAO for the IBM Cloud SQL Query Jobs 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 MyJobsDAO { //insert new data into IBM Cloud SQL Query @SqlUpdate("INSERT INTO Jobs (UserId, Status) values (:userId, :status)") void insert(@Bind("userId") String userId, @Bind("status") String status); //request specific data from IBM Cloud SQL Query (String type is used for simplicity) @SqlQuery("SELECT Status FROM Jobs WHERE UserId = :userId") String findStatusByUserId(@Bind("userId") String userId); /* * close with no args is used to close the connection */ void close(); }

Open a Connection to IBM Cloud SQL Query

Collect the necessary connection properties and construct the appropriate JDBC URL for connecting to IBM Cloud SQL Query.

IBM Cloud SQL uses the OAuth and HMAC authentication standards. See the "Getting Started" chapter of the help documentation for a guide to using OAuth.

Built-in Connection String Designer

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

java -jar cdata.jdbc.ibmcloudsqlquery.jar

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

A connection string for IBM Cloud SQL Query will typically look like the following:

jdbc:ibmcloudsqlquery:Api Key=MyAPIKey;Instance CRN=myInstanceCRN;Region=myRegion;Schema=mySchema;OAuth Client Id=myOAuthClientId;OAuth Client Secret=myOAuthClientSecret;InitiateOAuth=GETANDREFRESH

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:ibmcloudsqlquery:Api Key=MyAPIKey;Instance CRN=myInstanceCRN;Region=myRegion;Schema=mySchema;OAuth Client Id=myOAuthClientId;OAuth Client Secret=myOAuthClientSecret;InitiateOAuth=GETANDREFRESH"); MyJobsDAO dao = dbi.open(MyJobsDAO.class); //do stuff with the DAO dao.close();

Read IBM Cloud SQL Query Data

With the connection open to IBM Cloud SQL Query, simply call the previously defined method to retrieve data from the Jobs entity in IBM Cloud SQL Query.

//disply the result of our 'find' method String status = dao.findStatusByUserId("user@domain.com"); System.out.println(status);

Write IBM Cloud SQL Query Data

It is also simple to write data to IBM Cloud SQL Query, using the previously defined method.

//add a new entry to the Jobs entity dao.insert(newUserId, newStatus);

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