Create a Data Access Object for DigitalOcean Data using JDBI

Ready to get started?

Download for a free trial:

Download Now

Learn more:

DigitalOcean JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with DigitalOcean account data including Droplets, Images, Volumes, and more!

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

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

Open a Connection to DigitalOcean

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

DigitalOcean uses OAuth 2.0 authentication. To authenticate using OAuth, you can use the embedded credentials or register an app with DigitalOcean.

See the Getting Started guide in the CData driver documentation for more information.

Built-in Connection String Designer

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

java -jar cdata.jdbc.digitalocean.jar

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

A connection string for DigitalOcean 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:digitalocean:InitiateOAuth=GETANDREFRESH"); MyDropletsDAO dao =; //do stuff with the DAO dao.close();

Read DigitalOcean Data

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

//disply the result of our 'find' method String name = dao.findNameById("1"); System.out.println(name);

Write DigitalOcean Data

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

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

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