Create a Data Access Object for Databricks Data using JDBI

Ready to get started?

Download for a free trial:

Download Now

Learn more:

Databricks JDBC Driver

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



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

Create a DAO for the Databricks Customers 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 MyCustomersDAO { //insert new data into Databricks @SqlUpdate("INSERT INTO Customers (Country, CompanyName) values (:country, :companyName)") void insert(@Bind("country") String country, @Bind("companyName") String companyName); //request specific data from Databricks (String type is used for simplicity) @SqlQuery("SELECT CompanyName FROM Customers WHERE Country = :country") String findCompanyNameByCountry(@Bind("country") String country); /* * close with no args is used to close the connection */ void close(); }

Open a Connection to Databricks

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

To connect to a Databricks cluster, set the properties as described below.

Note: The needed values can be found in your Databricks instance by navigating to Clusters, and selecting the desired cluster, and selecting the JDBC/ODBC tab under Advanced Options.

  • Server: Set to the Server Hostname of your Databricks cluster.
  • HTTPPath: Set to the HTTP Path of your Databricks cluster.
  • Token: Set to your personal access token (this value can be obtained by navigating to the User Settings page of your Databricks instance and selecting the Access Tokens tab).

Built-in Connection String Designer

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

java -jar cdata.jdbc.databricks.jar

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

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

jdbc:databricks:Server=127.0.0.1;Port=443;TransportMode=HTTP;HTTPPath=MyHTTPPath;UseSSL=True;User=MyUser;Password=MyPassword;

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:databricks:Server=127.0.0.1;Port=443;TransportMode=HTTP;HTTPPath=MyHTTPPath;UseSSL=True;User=MyUser;Password=MyPassword;"); MyCustomersDAO dao = dbi.open(MyCustomersDAO.class); //do stuff with the DAO dao.close();

Read Databricks Data

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

//disply the result of our 'find' method String companyName = dao.findCompanyNameByCountry("US"); System.out.println(companyName);

Write Databricks Data

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

//add a new entry to the Customers entity dao.insert(newCountry, newCompanyName);

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