Connect to Lakebase Data in DBArtisan

The CData ODBC Driver for Lakebase seamlessly integrates Lakebase data into database management tools like DBArtisan by enabling you to access Lakebase data as a database. This article shows how to create an data source for Lakebase in DBArtisan and execute queries. You can then edit data visually and execute standard SQL.

Integrate Lakebase Data into DBArtisan Projects

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.

To connect to Databricks Lakebase, start by setting the following properties:

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

You can then follow the steps below to register Lakebase data as a database instance in your project:

1. In DBArtisan, click Data Source -> Register Datasource.
2. Select Generic ODBC.
3. Enter a name for the data source and select the DSN. 👁 The DSN of the data source to be registered. (Salesforce is shown.)
   
4. Finish the wizard to connect to Lakebase data. Lakebase entities are displayed in the Datasource Explorer. 👁 The Datasource Explorer. (Salesforce is shown.)
   

You can now work with Lakebase data as you work with any other database. See the driver help documentation for more information on the queries supported by the Lakebase API.

👁 The results of a query. (Salesforce is shown.)