Use the CData ODBC Driver for Hugging Face in MicroStrategy

MicroStrategy is an analytics and mobility platform that enables data-driven innovation. When you pair MicroStrategy with the CData ODBC Driver for Hugging Face, you gain database-like access to live Hugging Face data from MicroStrategy, expanding your reporting and analytics capabilities. In this article, we walk through creating a database instance for Hugging Face in MicroStrategy Developer and creating a Warehouse Catalog based on Hugging Face data.

The CData ODBC driver offers unmatched performance for interacting with live Hugging Face data in MicroStrategy due to optimized data processing built into the driver. When you issue complex SQL queries from MicroStrategy 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 (often SQL functions and JOIN operations) client-side. With built-in dynamic metadata querying, you can visualize and analyze Hugging Face data using native MicroStrategy data types.

Connect to Hugging Face as an ODBC Data Source

Information for connecting to Hugging Face follows, along with different instructions for configuring a DSN in Windows and Linux environments (the ODBC Driver for Hugging Face must be installed on the machine hosting the connected MicroStrategy Intelligence Server).

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';

When you configure the DSN, you may also want to set the Max Rows connection property. This will limit the number of rows returned, which is especially helpful for improving performance when designing reports and visualizations.

Windows

If you have not already, first specify connection properties in an ODBC DSN (data source name). This is the last step of the driver installation. You can use the Microsoft ODBC Data Source Administrator to create and configure ODBC DSNs.

Linux

If you are installing the CData ODBC Driver for Hugging Face in a Linux environment, the driver installation predefines a system DSN. You can modify the DSN by editing the system data sources file (/etc/odbc.ini) and defining the required connection properties.

/etc/odbc.ini

[CData API Sys]
Driver = CData ODBC Driver for Hugging Face
Description = My Description
Profile = C:\profiles\HuggingFace.apip
ProfileSettings = 'APIKey = hf_xxxxxxxxxxxxxxxxxxxx'

For specific information on using these configuration files, please refer to the help documentation (installed and found online).

Create a Hugging Face Database Instance in MicroStrategy Developer

You can connect to Hugging Face in MicroStrategy Developer by adding a database instance based on the CData ODBC Driver for Hugging Face.^*

1. Open MicroStrategy Developer and select a Project Source.
2. Navigate to Administration -> Configuration Managers -> Database Instances and right-click to add a new instance.
3. Name the instance, select Generic DBMS as the database connection type, and create a new database connection.
4. In the database connection wizard, name the connection and create a new Database Login name, using filler values for the user and password.
5. Select the DSN that you configured earlier as the ODBC data source (i.e., CData API Sys).
6. Select the newly created database connection.

7. In the Project Source, right-click the project and open the Project configuration.
8. Navigate to Database Instances and select the newly created database instance.
9. Close MicroStrategy Developer and restart the connected MicroStrategy Intelligence Server to complete the database instance creation.

With the database instance configured, you will now be able to connect to Hugging Face data from the Warehouse Catalog and Data Import.

Connect to Hugging Face Data from the Warehouse Catalog

Once you have created a database instance based on the ODBC Driver for Hugging Face, you can connect to data from the Warehouse Catalog.

1. Select your project and click Schema -> Warehouse Catalog.
2. In the Read Settings for the Catalog, click Settings and set the queries to retrieve the schema:
   • To retrieve the list of tables, use the following query:

     SELECT 
       CatalogName NAME_SPACE,
       TableName TAB_NAME 
     FROM 
       SYS_TABLES
             

   • To retrieve the list of columns for selected tables, use the following query:

     SELECT DISTINCT 
       CatalogName NAME_SPACE, 
       TableName TAB_NAME, 
       ColumnName COL_NAME, 
       DataTypeName DATA_TYPE, 
       Length DATA_LEN, 
       NumericPrecision DATA_PREC, 
       NumericScale DATA_SCALE 
     FROM 
       SYS_TABLECOLUMNS 
     WHERE 
       TableName IN (#TABLE_LIST#) 
     ORDER BY
       1,2,3
             

   
3. Select tables to be used in the project.

If you are interested in connecting to Hugging Face from other MicroStrategy products, you can read about connecting from MicroStrategy Web and connecting from MicroStrategy Desktop.

Note: connecting using a ODBC driver requires a 3- or 4-tier architecture.