How to connect to Clarifai Data from IntelliJ

The CData JDBC Driver for Clarifai enables you to access Clarifai as a JDBC data source, providing integration with rapid development tools in IDEs. This article shows how to use the data source configuration wizard to connect to Clarifai data in IntelliJ.

Create a JBDC Data Source for Clarifai

Follow the steps below to add the driver JAR and define connection properties required to connect to Clarifai data.

1. In the Data Sources window, right-click and then click Add Data Source -> DB Data Source.

2. In the Data Source Properties dialog that appears, the following properties are required:

   • JDBC Driver Files: Click the button next to this menu to add the JDBC Driver file cdata.jdbc.api.jar, located in the installation directory.
   • JDBC Driver Class: In this menu, select cdata.jdbc.api.APIDriver from the list.

   • Database URL: Enter the connection URL in the JDBC URL property. The URL must start with jdbc:api: and includes connection properties separated with semicolons.

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

     Clarifai API Profile Settings

     Clarifai uses Personal Access Tokens (PATs) for authentication. To obtain a PAT:

     1. Log in to your Clarifai account at https://clarifai.com.
     2. Navigate to your profile settings and select Security.
     3. Click Create Personal Access Token.
     4. Select the required scopes and click Create Token.
     5. Copy the generated token (it will only be shown once).

     After obtaining your Personal Access Token, set the following connection properties:

     • AuthScheme: Set this to APIKey.

     Set the following in the ProfileSettings connection property:

     • APIKey: Set this to your Clarifai Personal Access Token (PAT).

     Built-in Connection String Designer

     For assistance in constructing the JDBC URL, use the connection string designer built into the Clarifai 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 typical JDBC URL is the following:

     jdbc:api:Profile=C:\profiles\Clarifai.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_personal_access_token';

Edit and Save Clarifai Data

To discover schema information, right-click the data source you just created and click Refresh Tables. To query a table, right-click it and then click Open Tables Editor.