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

Create a DAO for the Pinecone Indexes 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 MyIndexesDAO {
  //request specific data from Pinecone (String type is used for simplicity)
  @SqlQuery("SELECT  FROM Indexes WHERE Name = :name")
  String findByName(@Bind("name") String name);

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

Open a Connection to Pinecone

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

Authentication

To authenticate to Pinecone, and connect to your own data or to allow other users to connect to their data, you can use API Key authentication.

Using API Key Authentication

To authenticate using an API Key, you need to obtain your API Key from your Pinecone console at https://app.pinecone.io/.

You can then connect by setting the AuthScheme to APIKey and providing your API key:

• AuthScheme: Set this to APIKey.
• APIKey: Set this to your API key from Pinecone.

Example connection strings:

Standard API Key Configuration:

Profile=C:\profiles\Pinecone.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_api_key;APIVersion=2025-10';

Built-in Connection String Designer

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

jdbc:api:Profile=C:\profiles\Pinecone.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_api_key;APIVersion=2025-10';

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\Pinecone.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_api_key;APIVersion=2025-10';");
MyIndexesDAO dao = dbi.open(MyIndexesDAO.class);

//do stuff with the DAO

dao.close();

Read Pinecone Data

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

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

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