Manage Clarifai Data in DBArtisan as a JDBC Source

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

Integrate Clarifai Data into DBArtisan Projects

Follow the steps below to register Clarifai 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.
5. In the Connection URL box, enter credentials and other required connection properties in the JDBC URL.

   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.

   

   Below is a typical connection string:

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

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

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