Manage Pinecone Data in DBArtisan as a JDBC Source

The CData JDBC Driver for Pinecone seamlessly integrates Pinecone data into database management tools like DBArtisan by enabling you to access Pinecone data as a database. This article shows how to create a JDBC source for Pinecone in DBArtisan. You can then edit data visually and execute standard SQL.

Integrate Pinecone Data into DBArtisan Projects

Follow the steps below to register Pinecone data as a database instance in your project:

1. In DBArtisan, click Data Source -> Register Datasource.
2. Select Generic JDBC.
3. Click Manage.
4. In the resulting dialog, click New. Enter a name for the driver and click Add. In the resulting dialog, navigate to the driver JAR. The driver JAR is located in the lib subfolder of the installation directory. 👁 The JDBC driver definition in the Register Datasource wizard. (Salesforce is shown.)
   
5. In the Connection URL box, enter credentials and other required connection properties in the JDBC URL.

   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.

   👁 Required JDBC connection properties in the Register Datasource wizard. (Salesforce is shown.)
   

   Below is a typical connection string:

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

6. Finish the wizard to connect to Pinecone data. Pinecone entities are displayed in the Datasource Explorer.

You can now work with Pinecone data as you work with any other database. See the driver help documentation for more information on the queries supported by the Pinecone API.