Create a Data Access Object for Supabase Data using 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 Supabase integrates connectivity to live Supabase data in Java applications. By pairing these technologies, you gain simple, programmatic access to Supabase data. This article explains how to build a basic Data Access Object (DAO) and the accompanying code to read Supabase data.

Create a DAO for the Supabase Branch 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 MyBranchDAO {
  //request specific data from Supabase (String type is used for simplicity)
  @SqlQuery("SELECT PostgresVersion FROM Branch WHERE Status = :status")
  String findPostgresVersionByStatus(@Bind("status") String status);

  /*
   * close with no args is used to close the connection
   */
  void close();
}

Open a Connection to Supabase

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

Start by setting the Profile connection property to the location of the Supabase Profile on disk (e.g. C:\profiles\Supabase.apip). Next, set the ProfileSettings connection property to the connection string for Supabase (see below).

Supabase API Profile Settings

Log into your Supabase account and navigate to Account Settings > Access Tokens to generate a new personal access token.

Built-in Connection String Designer

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

java -jar cdata.jdbc.api.jar

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

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

jdbc:api:Profile=C:\profiles\Supabase.apip;ProfileSettings='APIKey=your_api_key';

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:api:Profile=C:\profiles\Supabase.apip;ProfileSettings='APIKey=your_api_key';");
MyBranchDAO dao = dbi.open(MyBranchDAO.class);

//do stuff with the DAO

dao.close();

Read Supabase Data

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

//disply the result of our 'find' method
String postgresVersion = dao.findPostgresVersionByStatus("active");
System.out.println(postgresVersion);

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