How to Query Lakebase Data in MySQL Workbench

You can use the SQL Gateway from the ODBC Driver for Lakebase to query Lakebase data through a MySQL interface. Follow the procedure below to start the MySQL remoting service of the SQL Gateway and work with live Lakebase data in MySQL Workbench.

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.

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.

Query Lakebase from MySQL Workbench

The steps below outline connecting to the virtual Lakebase database created in the SQL Gateway from MySQL Workbench and issuing basic queries to work with live Lakebase data.

Connect to Lakebase through the SQL Gateway

1. In MySQL Workbench, click to add a new MySQL connection.
2. Name the connection (CData SQL Gateway for Lakebase).
3. Set the Hostname, Port, and Username parameters to connect to the SQL Gateway.
4. Click Store in Vault to set and store the password.
5. Click Test Connection to ensure the connection is configured properly and click OK.

NOTE: When we refer to Username and Password, we mean the credentials for the user(s) created for the SQL Gateway.

Query Lakebase Data

1. Open the connection you just created (CData SQL Gateway for Lakebase).
2. Click File -> New Query Tab.
3. Write a SQL query to retrieve Lakebase data, like SELECT * FROM `CData Lakebase Sys`.Orders;

With access to live Lakebase data from MySQL Workbench, you can easily work with Lakebase, just like you would a MySQL database. Get started now with a free, 30-day trial of the CData ODBC Driver for Lakebase and the CData SQL Gateway.