Connect to Hugging Face Data in RazorSQL

The CData JDBC Driver for Hugging Face enables standards-based access from third-party tools, from wizards in IDEs to data management and analysis tools. This article shows how to connect to Hugging Face using wizards in RazorSQL.

Create a JDBC Data Source for Hugging Face Data

1. Open the RazorSQL application and, in the Connections menu, select Add Connection Profile -> Other -> JDBC.
2. In the Connection Wizard that appears, set the following properties:
   • Driver Location: Set this property to the path to the lib subfolder in the installation directory.
   • Driver Class: Set the driver class to cdata.jdbc.api.APIDriver.
   • Username: Enter the username. (This property can also be set in the JDBC URL.)
   • Password: Enter the password. (This property can also be set in the JDBC URL.)

   • JDBC URL: Enter connection parameters. The JDBC URL begins with jdbc:api: and is followed by a semicolon-separated list of connection properties.

     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.

     👁 Using the built-in connection string designer to generate a JDBC URL (Salesforce is shown.)
     

     A typical JDBC URL is the following:

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

Query Hugging Face Data and Select Tables

After establishing a connection, the wizard will close and the connection will be available in the connections panel. You can then query the tables.