Create a Data Access Object for CockroachDB Data using JDBI

Ready to get started?

Download for a free trial:

Download Now

Learn more:

CockroachDB JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with CockroachDB.



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

Create a DAO for the CockroachDB Orders 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 MyOrdersDAO { //insert new data into CockroachDB @SqlUpdate("INSERT INTO Orders (ShipCountry, ShipCity) values (:shipCountry, :shipCity)") void insert(@Bind("shipCountry") String shipCountry, @Bind("shipCity") String shipCity); //request specific data from CockroachDB (String type is used for simplicity) @SqlQuery("SELECT ShipCity FROM Orders WHERE ShipCountry = :shipCountry") String findShipCityByShipCountry(@Bind("shipCountry") String shipCountry); /* * close with no args is used to close the connection */ void close(); }

Open a Connection to CockroachDB

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

Set the following to connect to CockroachDB.

  • Server: The host name or IP address of the server.
  • Port: The port number of the CockroachDB server. If not specified, the default port is 26257.
  • Database: The name of the Cockroach database. If not specified, you connect to the user's default database.
  • User: The Cockroach DB user account used to authenticate.
  • Password: The password used to authenticate the user.

Built-in Connection String Designer

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

java -jar cdata.jdbc.cockroachdb.jar

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

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

jdbc:cockroachdb:User=root;Password=root;Database=system;Server=localhost;Port=26257

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:cockroachdb:User=root;Password=root;Database=system;Server=localhost;Port=26257"); MyOrdersDAO dao = dbi.open(MyOrdersDAO.class); //do stuff with the DAO dao.close();

Read CockroachDB Data

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

//disply the result of our 'find' method String shipCity = dao.findShipCityByShipCountry("USA"); System.out.println(shipCity);

Write CockroachDB Data

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

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

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