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

Create a DAO for the Hugging Face Collections 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 MyCollectionsDAO {
  //request specific data from Hugging Face (String type is used for simplicity)
  @SqlQuery("SELECT  FROM Collections WHERE  = :")
  String findBy(@Bind("") String );

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

Open a Connection to Hugging Face

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

HuggingFace Hub uses token-based authentication to enable access to its API. The API provides access to machine learning models, datasets, spaces, papers, and other resources on the HuggingFace Hub platform.

Using API Key Authentication

To authenticate to HuggingFace Hub, you will need to provide an API Key (Access Token). To obtain your access token:

1. Log in to your HuggingFace account at https://huggingface.co
2. Navigate to Settings > Access Tokens
3. Click "New token" to create a new access token
4. Select the appropriate permissions (read or write)
5. Copy the token value

After obtaining your access token, set the following connection properties:

• AuthScheme: Set this to APIKey.
• APIKey: Set this to your HuggingFace access token.

Example connection string

Profile=C:\profiles\HuggingFace.apip;ProfileSettings='APIKey=hf_xxxxxxxxxxxxxxxxxxxx';

Built-in Connection String Designer

For assistance in constructing the JDBC URL, use the connection string designer built into the Hugging Face 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 Hugging Face will typically look like the following:

jdbc:api:Profile=C:\profiles\HuggingFace.apip;ProfileSettings='APIKey=hf_xxxxxxxxxxxxxxxxxxxx';

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\HuggingFace.apip;ProfileSettings='APIKey=hf_xxxxxxxxxxxxxxxxxxxx';");
MyCollectionsDAO dao = dbi.open(MyCollectionsDAO.class);

//do stuff with the DAO

dao.close();

Read Hugging Face Data

With the connection open to Hugging Face, simply call the previously defined method to retrieve data from the Collections entity in Hugging Face.

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

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