Validate Hugging Face Data with QuerySurge

Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
Access and validate Hugging Face data in QuerySurge using the CData JDBC Driver.

QuerySurge is a smart data testing solution that automates data validation and testing. When paired with the CData API Driver for JDBC, QuerySurge can work with live Hugging Face data. This article explains how to connect to Hugging Face data from QuerySurge.

With built-in optimized data processing, the CData JDBC Driver offers unmatched performance for interacting with live Hugging Face data. When you issue complex SQL queries to Hugging Face, the driver pushes supported SQL operations, like filters and aggregations, directly to Hugging Face and utilizes the embedded SQL engine to process unsupported operations client-side (often SQL functions and JOIN operations). Its built-in dynamic metadata querying allows you to work with and analyze Hugging Face data using native data types.

Connecting to Hugging Face Data in QuerySurge

To connect to live Hugging Face data from QuerySurge, you need to deploy the JDBC Driver JAR file to your QuerySurge Agent(s) and add a new connection from the QuerySurge Admin view.

Deploy the JDBC Driver

  1. Download the CData API Driver for JDBC installer, unzip the package, and run the JAR file to install the driver.
  2. Once the driver is installed, stop the Agent Service.
  3. Copy the JAR File (and license file if it exists) from the installation location (typically C:\Program Files\CData\CData API Driver for JDBC\lib\) to your Agent(s) (QuerySurge_install_dir\agent\jdbc).
  4. Restart the Agent Service.

For more information on deploying JDBC drivers for QuerySurge, refer to the QuerySurge Knowledge Base.

Configure a New Connection to Hugging Face

  1. Log into QuerySurge and navigate to the Admin view.
  2. Click Configuration -> Connections in the Administration Tree.
  3. Click Add to create a new connection.
  4. In the QuerySurge Connection Wizard, click Next.
  5. Name the connection (e.g. CData JDBC Connection to Hugging Face).
  6. Set the Data Source to "All Other JDBC Connections (Connection Extensibility)" and click Next.
  7. Set the Driver Class to cdata.jdbc.api.APIDriver and click Next.
  8. Set the Connection URL using the necessary connection properties to authenticate with Hugging Face. Your Connection URL will look something like the following:

    jdbc:api: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.

    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';
    
  9. Set the Test Query to enable the Test Connection button for the Connection (e.g. SELECT * FROM Collections LIMIT 1) and click Next.
  10. Click Test Connection to ensure the connection is configured properly and click Save to add the connection.

Once the connection is added, you can write SQL queries against your Hugging Face data in QuerySurge.

Compare Hugging Face Data Queries with a QueryPair

With the connection configured, you can follow the steps below to compare querying Hugging Face data with a QueryPair.

  1. Select "Design Library" from the Design Menu
  2. Click QueryPairs under QuerySurge Design
  3. Click "Create New QueryPair"
  4. Name the QueryPair and click Save
  5. In either the Source or Target panes, select the connection created above (select the same connection to query Hugging Face twice or another connection to perform a comparison)
  6. Write queries in the Editor for each pane, e.g. SELECT * FROM Collections
  7. Click the "Design-Time Run" tab to execute the queries
  8. When the query execution is finished, click "View Query Results" to see the Hugging Face data returned by the query

Download a free, 30-day trial of the CData API Driver for JDBC and start working with your live Hugging Face data in QuerySurge. Reach out to our Support Team if you have any questions.

Ready to get started?

Connect to live data from Hugging Face with the API Driver

Connect to Hugging Face