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

Create a DAO for the Tavily Search 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 MySearchDAO {
  //request specific data from Tavily (String type is used for simplicity)
  @SqlQuery("SELECT Answer FROM Search WHERE Query = :query")
  String findAnswerByQuery(@Bind("query") String query);

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

Open a Connection to Tavily

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

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

Tavily API Profile Settings

Obtain your API key from your Tavily account dashboard after signing up or logging in.

Built-in Connection String Designer

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

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

//do stuff with the DAO

dao.close();

Read Tavily Data

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

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

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