Access Lakebase Data from MySQL in HeidiSQL

HeidiSQL is an open-source database administration tool that natively supports MariaDB, MySQL, SQL Server, and PostgreSQL. When paired with the CData ODBC Driver for Lakebase and SQL Gateway, HediSQL's reach extends to include access to live Lakebase data. This article demonstrates how to connect to on-premise Lakebase and query Lakebase data in HeidiSQL.

Connect to Lakebase Data

If you have not already done so, provide values for the required connection properties in the data source name (DSN). You can use the built-in Microsoft ODBC Data Source Administrator to configure the DSN. This is also the last step of the driver installation. See the "Getting Started" chapter in the help documentation for a guide to using the Microsoft ODBC Data Source Administrator to create and configure a DSN.

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

Configure the SQL Gateway

See the SQL Gateway Overview to set up connectivity to Lakebase data as a virtual MySQL database. You will configure a MySQL remoting service that listens for MySQL requests from clients. The service can be configured in the SQL Gateway UI.

To connect to the SQL Gateway from HeidiSQL, you will need to run the SQL Gateway on a web-facing machine. After configuring the SQL Gateway, make note of the following information:

• The IP address or domain name of the machine hosting the SQL Gateway
• The data source name (likely CData Lakebase Sys) of the MySQL service
• The port number of the MySQL service
• The credentials of a SQL Gateway user with access to the service

Configure Remote Access

If your ODBC Driver and the remoting service are installed on-premise (and not accessible from HeidiSQL), you can use the reverse SSH tunneling feature to enable remote access. For detailed instructions, read our Knowledge Base article: SQL Gateway SSH Tunneling Capabilities.

Connect to Lakebase in HeidiSQL

Once you have a MySQL Service configured for the CData ODBC Driver for Lakebase, you are ready to connect to the data in HeidiSQL. Start by creating a new connection Session in HeidiSQL, then choose the MySQL library type.

Configure the data set using the values for the MySQL service for Lakebase you configured in SQL Gateway (be sure to use the DSN for the database name). Validate your connection and click Open.

Query Lakebase from HeidiSQL

1. In the database listing on the left, find your connection to Lakebase configured earlier.
2. In the database listing on the left, expand the appropriate connection and to view individual tables or data objects present within Lakebase.
3. Write custom SQL queries targeting these tables, treating the data source like any SQL Server database, or visually explore each tabular data set by selecting the relevant tables

With the CData ODBC Driver for Lakebase and SQL Gateway, you are able to easily query data from Lakebase data in HeidiSQL. If you have any questions, such as needing to access your on-premises data from HeidiSQL, let our Support Team know.