Use the CData ODBC Driver for Lakebase in MicroStrategy Web

MicroStrategy is an analytics and mobility platform that enables data-driven innovation. When you pair MicroStrategy with the CData ODBC Driver for Lakebase, you gain database-like access to live Lakebase data from MicroStrategy, expanding your reporting and analytics capabilities. In this article, we walk through adding Lakebase as external data in MicroStrategy Web and creating a simple visualization of Lakebase data.

The CData ODBC driver offers unmatched performance for interacting with live Lakebase data in MicroStrategy due to optimized data processing built into the driver. When you issue complex SQL queries from MicroStrategy to Lakebase, the driver pushes supported SQL operations, like filters and aggregations, directly to Lakebase 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 Lakebase data using native MicroStrategy data types.

Connect to Lakebase as an ODBC Data Source

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

• DatabricksInstance: The Databricks instance or server hostname, provided in the format instance-abcdef12-3456-7890-abcd-abcdef123456.database.cloud.databricks.com.
• Server: The host name or IP address of the server hosting the Lakebase database.
• Port (optional): The port of the server hosting the Lakebase database, set to 5432 by default.
• Database (optional): The database to connect to after authenticating to the Lakebase Server, set to the authenticating user's default database by default.

OAuth Client Authentication

To authenicate using OAuth client credentials, you need to configure an OAuth client in your service principal. In short, you need to do the following:

1. Create and configure a new service principal
2. Assign permissions to the service principal
3. Create an OAuth secret for the service principal

For more information, refer to the Setting Up OAuthClient Authentication section in the Help documentation.

OAuth PKCE Authentication

To authenticate using the OAuth code type with PKCE (Proof Key for Code Exchange), set the following properties:

• AuthScheme: OAuthPKCE.
• User: The authenticating user's user ID.

For more information, refer to the Help documentation.

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 Lakebase 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 Lakebase Sys]
Driver = CData ODBC Driver for Lakebase
Description = My Description
DatabricksInstance = lakebase
Server = 127.0.0.1
Port = 5432
Database = my_database
InitiateOAuth = GETANDREFRESH

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

Connect to and Visualize Lakebase Data using MicroStrategy Web

Once you have created a database instance in MicroStrategy Developer and connected it to a project, you can perform a data import of Lakebase data from MicroStrategy Web. Alternatively, you can create a new data source based on the ODBC Driver.^*

1. Open MicroStrategy Web and select your project.
2. Click Add External Data, select Databases, and choose Select a Table as the Import Option.
3. In the Import from Tables wizard, click to add a new data source.
   • Select DSN Data Sources
   • Set the DSN property to the previously configured DSN (CData Lakebase Sys)
   • Set the Version property to Generic DBMS
   • Set the User and Password properties (or use filler values)
   • Set the Data Source Name
   
4. After creating the data source, click to edit the catalog options and set the following queries and click OK.
   • SQL statement to retrieve tables available in the data source

     SELECT
       CatalogName NAME_SPACE,
       TableName TAB_NAME
     FROM
       SYS_TABLES
         

   • SQL statement to retrieve columns for the selected tables

     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
         

5. Drag a table into the pane. Note: Since we create a live connection, we can import whole tables and utilize the filtering and aggregation features native to the MicroStrategy products.
6. Click Finish, choose to the option to connect live, save the query, and choose the option to create a new dossier.
7. Choose a visualization, choose fields to display, and apply any filters to create a new visualization of Lakebase data. Data types are discovered automatically through dynamic metadata discovery. Where possible, the complex queries generated by the filters and aggregations will be pushed down to Lakebase, while any unsupported operations (which can include SQL functions and JOIN operations) will be managed client-side by the CData SQL engine embedded in the driver.
8. Once you have finished configuring the dossier, click File -> Save.

Using the CData ODBC Driver for Lakebase in MicroStrategy Web, you can easily create robust visualizations and reports on Lakebase data. Read our other articles on connecting to Lakebase in MicroStrategy and connecting to Lakebase in MicroStrategy Desktop for more examples.

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