Connect to Lakebase Data in DBeaver

The CData ODBC Driver for Lakebase enables access to live data from Lakebase under the ODBC standard, allowing you work with Lakebase data in a wide variety of BI, reporting, and ETL tools and directly, using familiar SQL queries. This article shows how to manage Lakebase data with visual tools in DBeaver like the query browser.

The CData ODBC drivers offer unmatched performance for interacting with live Lakebase data in DBeaver due to optimized data processing built into the driver. When you issue complex SQL queries from DBeaver 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 manage and analyze Lakebase data.

Connect to Lakebase

If you have not already done so, provide values for the required connection properties in the data source name (DSN). You can configure the DSN using the Microsoft ODBC Data Source Administrator. 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.

Finally, set the "Map To WVarchar connection property to False in the DSN Configuration window for the driver. This configuration will allow string types to be mapped to SQL_VARCHAR and prevent SQL_WVARCHAR types from being displayed as NULL.

Connecting to the Lakebase ODBC Data Source in DBeaver

1. Open the DBeaver application and in the Database menu, select the New Database Connection option.
2. In the 'Connect to a database' window, select ODBC and click Next.
3. In the Database/Schema field, enter the DSN name (CData Lakebase Source by default). It will be automatically added to the JDBC URL as well.
4. Click the Test Connection button. You should receive a 'Connected' message after DBeaver has detected the DSN, along with details about the driver if the connection is successful.

Query Lakebase Data

You can now query information from the tables exposed by the data source connection. You can expand the database structure in order to view all the tables. You can retrieve the table's data by right-clicking on a table name and selecting View data. The data will then be available in the Data tab.

Free Trial & More Information

At this point, you have connected to live Lakebase data from DBeaver. For more information, visit the CData ODBC Driver page. Download a free, 30-day trial and start working live Lakebase data DBeaver today.