How to connect to Lakebase Data from IntelliJ

The CData JDBC Driver for Lakebase enables you to access Lakebase as a JDBC data source, providing integration with rapid development tools in IDEs. This article shows how to use the data source configuration wizard to connect to Lakebase data in IntelliJ.

Create a JBDC Data Source for Lakebase

Follow the steps below to add the driver JAR and define connection properties required to connect to Lakebase data.

1. In the Data Sources window, right-click and then click Add Data Source -> DB Data Source.

2. In the Data Source Properties dialog that appears, the following properties are required:

   • JDBC Driver Files: Click the button next to this menu to add the JDBC Driver file cdata.jdbc.lakebase.jar, located in the installation directory.
   • JDBC Driver Class: In this menu, select cdata.jdbc.lakebase.LakebaseDriver from the list.

   • Database URL: Enter the connection URL in the JDBC URL property. The URL must start with jdbc:lakebase: and includes connection properties separated with semicolons.

     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.

     Built-in Connection String Designer

     For assistance in constructing the JDBC URL, use the connection string designer built into the Lakebase JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

     java -jar cdata.jdbc.lakebase.jar
     

     Fill in the connection properties and copy the connection string to the clipboard.

     👁 Using the built-in connection string designer to generate a JDBC URL (Salesforce is shown.)
     

     A typical JDBC URL is the following:

     jdbc:lakebase:DatabricksInstance=lakebase;Server=127.0.0.1;Port=5432;Database=my_database;InitiateOAuth=GETANDREFRESH;

Edit and Save Lakebase Data

To discover schema information, right-click the data source you just created and click Refresh Tables. To query a table, right-click it and then click Open Tables Editor. You can also modify records in the Table Editor.