Use JayDeBeApi to access Hugging Face Data in Python

Access Hugging Face data with Python scripts and standard SQL on any machine where Python and Java can be installed. You can use the CData API Driver for JDBC and the JayDeBeApi module to work with remote Hugging Face data in Python. By using the CData Driver, you are leveraging a driver written for industry-proven standards to access your data in the popular Python language. This article shows how to use the driver to execute SQL queries to Hugging Face and visualize Hugging Face data with standard Python.

Use the JayDeBeApi module

JayDeBeApi is a Python library that serves as a JDBC (Java Database Connectivity) bridge, allowing Python programs to interact with Java databases, including CData JDBC Drivers. Use the pip install command to install the module:

pip install JayDeBeApi

Create the JDBC URL

Once you have JayDeBeApi installed, you are ready to work with Hugging Face data in Python using SQL.

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.)

Below is a sample variable assignment, including a typical JDBC connection string:

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

Access Hugging Face data in Python

With the JDBC URL configured, you only need the absolute path to the JDBC driver JAR file, which is in the "lib" folder in the installation directory ("C:\Program Files\CData[product_name] 20XX\lib\cdata.jdbc.api.jar" on Windows).

NOTE: If you haven't already, set the JAVA_HOME environment variable to the Java installation directory.

Use code similar to the follow to read and print data from Hugging Face:

import jaydebeapi

#The JDBC connection string
jdbc_url = "jdbc:api:Profile=C:\profiles\HuggingFace.apip;ProfileSettings='APIKey=hf_xxxxxxxxxxxxxxxxxxxx';"

username = "****"
password = "****"

#The absolute Path to the JDBC driver JAR file, typically:
jdbc_driver_jar = "C:\Program Files\CData[product_name] 20XX\lib\cdata.jdbc.api.jar"

conn = jaydebeapi.connect(
 "cdata.jdbc.api.APIDriver",
 jdbc_url,
 [username, password],
 jdbc_driver_jar,
)

cursor = conn.cursor()
cursor.execute("SELECT * FROM Collections;")


results = cursor.fetchall()
for row in results:
 print(row)

cursor.close()
conn.close()

Free trial & more information

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