Create a Data Access Object for Avro Data using JDBI

Ready to get started?

Download for a free trial:

Download Now

Learn more:

Avro JDBC Driver

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



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

Create a DAO for the Avro SampleTable_1 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 MySampleTable_1DAO { //request specific data from Avro (String type is used for simplicity) @SqlQuery("SELECT Column1 FROM SampleTable_1 WHERE Column2 = :column2") String findColumn1ByColumn2(@Bind("column2") String column2); /* * close with no args is used to close the connection */ void close(); }

Open a Connection to Avro

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

Connect to your local Avro file(s) by setting the URI connection property to the location of the Avro file.

Built-in Connection String Designer

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

java -jar cdata.jdbc.avro.jar

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

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

jdbc:avro:URI=C:/folder/table.avroInitiateOAuth=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:avro:URI=C:/folder/table.avroInitiateOAuth=GETANDREFRESH"); MySampleTable_1DAO dao = dbi.open(MySampleTable_1DAO.class); //do stuff with the DAO dao.close();

Read Avro Data

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

//disply the result of our 'find' method String column1 = dao.findColumn1ByColumn2("value_2"); System.out.println(column1);

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