Use the CData ODBC Driver for Lakebase in MicroStrategy Desktop

MicroStrategy is an analytics and mobility platform that enables data-driven innovation. When paired 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 a data source in MicroStrategy Desktop 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.

• 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 Desktop

In addition to connecting Lakebase in MicroStrategy enterprise products, you can connect to Lakebase in MicroStrategy Desktop. Follow the steps below to add Lakebase data as a dataset and create visualizations and reports of Lakebase data.

1. Open MicroStrategy Desktop and create a new dossier.
2. In the datasets panel, click New Data, select Databases, and select Type a Query as the Import Option.
3. Add a new data source and choose DSN data sources.
4. Choose the DSN you previously configured (likely CData Lakebase Sys) and select Generic DBMS in the Version menu.
5. Set the User and Password properties for the DSN (or use placeholder values) and name the data source.

6. Select the new database instance to view the tables. You may need to manually click the search icon in the Available Tables section to see the tables.
7. Create a SQL query for the Lakebase data (see below) and click Execute SQL to test the query.

   SELECT * FROM Orders
   

   NOTE: Since we create a live connection, we can execute a SELECT * query and utilize the filtering and aggregation features native to the MicroStrategy products.
8. Click Finish and choose to connect live.
9. Choose a visualization, choose fields to display (data types are discovered automatically through dynamic metadata discovery) and apply any filters to create a new visualization of Lakebase data. 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.
10. Once you are finished configuring the dossier, click File -> Save.

Using the CData ODBC Driver for Lakebase in MicroStrategy Desktop, 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 Web for more examples.