Skip to main content
Applies to: Cloud and 3.272.0-edge

Connect to Databricks Lakebase

Learn how to connect Databricks Lakebase to Retool.

Databricks Lakehouse Availability
Cloud-hostedbeta
Self-hosted (3.272 Edge)beta
Self-hosted (Stable)Expected in Q3 2025 release.

You can use the Databricks Lakebase integration to create a resource and make it available in Retool. Once complete, your users can write queries that interact with Databricks Lakebase data.

Requirements​

The Databricks Lakebase integration requirements depend on whether you have a cloud-hosted or self-hosted Retool organization. You may also need to make Databricks Lakebase configuration changes before creating the resource.

Sufficient user permissions to create resources

All users for Retool organizations on Free or Team plans have global Edit permissions and can add, edit, and remove resources. If your organization manages user permissions for resources, you must be a member of a group with Edit all permissions.

Allow Retool to access the data source

If the data source is behind a firewall or restricts access based on IP address, then you must ensure that your Retool organization can access it. If necessary, configure your data source to allow access from Retool's IP addresses.

To allow Retool access from one of its outbound regions, you must include the necessary IP addresses in your allowlist if you use inbound firewall rules.

CIDR IP addresses
35.90.103.132/30
44.208.168.68/30
Individual IP addresses
35.90.103.132
35.90.103.133
35.90.103.134
35.90.103.135
44.208.168.68
44.208.168.69
44.208.168.70
44.208.168.71

Retool is building support for querying firewalled resources without allowlisting Retool’s IP address. To learn more or be considered for early access, contact cloud-connect@retool.com.

Databricks Lakebase settings and authentication

You must have sufficient access and familiarity with your Databricks Lakebase data source so you can provide:

  • Required connection settings (e.g., URL and server variables).
  • Authentication credentials (e.g., API keys).

In some cases, you may need to make changes to your Databricks Lakebase configuration, such as generating authentication credentials or allowing access through a firewall. Refer to the configuration and authentication sections to learn more.

Configure the resource​

Sign in to your Retool organization and navigate to the Resources tab. Click Create new > Resource, then select Databricks Lakebase.

Configuration​

Specify the name, location, and description to use for your Databricks Lakebase resource. Retool displays the resource name and type in query editors to help users identify them.

Provide the following configuration settings to create the resource. Depending on how your data source is configured, you may also need to provide optional settings for Retool to connect.

You can automatically populate resource configuration fields by providing a database connection string.

Name

The name to use for the resource.

Description

A description of the resource.

Host

The host server address.

Port

The host server connection port.

Database name

The name of the database to use.

Connection options

Key-value pairs to configure the connection.

Disable converting queries to prepared statements

Whether to disable SQL injection protection that allows dynamically generated SQL using JavaScript.

Override default outbound Retool region

Retool connects to your data source from the us-west-2 region. Choosing a different outbound region can improve performance through geographic proximity.

RegionLocation
us-west-2US West (Oregon)
eu-central-1Europe (Frankfurt, Germany)
ap-southeast-1Asia-Pacific (Singapore)
SSL/TLS validation

Retool strongly recommends using SSL/TLS certificate validation whenever it's available. This ensures the connection is secure and prevents attackers from using invalid server certificates to gain access to your data.

Authentication​

The Databricks Lakebase integration supports the following authentication methods. Depending on which authentication method you use, you may need to make changes to your Databricks Lakebase configuration.

Basic

Authentication is performed using Basic HTTP authentication with a username and password. You must be able to obtain and provide these credentials to create the resource.

OAuth 2.0

Authentication is performed using OAuth 2.0. Your users are redirected to to sign in and authorize Retool to access data.

Authorization URL

The URL with which to authenticate.

Retool prefills this value with a placeholder. Replace {databricksHost} with your Databricks Lakebase host.

https://{databricksHost}/oidc/v1/authorize
Access token URL

The access token URL.

Retool prefills this value with a placeholder. Replace {databricksHost} with your Databricks Lakebase host.

https://{databricksHost}/oidc/v1/token
Client ID

The client ID with which to authenticate.

Scopes

Scopes govern what permissions Retool has once you connect your account authenticates. For some integrations, Retool automatically populates a set of recommended scopes to make full use of the integration. In some cases, you may need to specify the scopes for Retool to use.

Access token lifespan

The lifespan of the access token before it expires.

Test the connection​

Click Test Connection to verify that Retool can successfully connect to the data source. If the test fails, check the resource settings and try again.

Testing a connection only checks whether Retool can successfully connect to the resource. It cannot check whether the provided credentials have sufficient privileges or can perform every supported action.

Save the resource​

Click Create resource to complete the setup. You can then click either Create app to immediately start building a Retool app or Back to resources to return to the list of resources.

Next steps​

Your Databricks Lakebase resource is now ready to use. Check out related queries and code documentation to learn how to interact with Databricks Lakebase data.