Manage Hugging Face Data in DBArtisan as a JDBC Source

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

Integrate Hugging Face Data into DBArtisan Projects

Follow the steps below to register Hugging Face 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.

   HuggingFace Hub uses token-based authentication to enable access to its API. The API provides access to machine learning models, datasets, spaces, papers, and other resources on the HuggingFace Hub platform.

   Using API Key Authentication

   To authenticate to HuggingFace Hub, you will need to provide an API Key (Access Token). To obtain your access token:

   1. Log in to your HuggingFace account at https://huggingface.co
   2. Navigate to Settings > Access Tokens
   3. Click "New token" to create a new access token
   4. Select the appropriate permissions (read or write)
   5. Copy the token value

   After obtaining your access token, set the following connection properties:

   • AuthScheme: Set this to APIKey.
   • APIKey: Set this to your HuggingFace access token.

   Example connection string

   Profile=C:\profiles\HuggingFace.apip;ProfileSettings='APIKey=hf_xxxxxxxxxxxxxxxxxxxx';
   

   Built-in Connection String Designer

   For assistance in constructing the JDBC URL, use the connection string designer built into the Hugging Face 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\HuggingFace.apip;ProfileSettings='APIKey=hf_xxxxxxxxxxxxxxxxxxxx';

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

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