Skip to main content

Connect to Databricks

Connection Modes: Direct

Connection

To connect to a Databricks Compute Cluster, select Add Datasource on the datasources overview page to open the Create Datasource dialog and select Databricks as the database type.

image-600 image-600

The Name is a required human-friendly identifier or description of the datasource in Cluvio. Datasource names need not be unique but we recommend to give each datasource a unique and meaningful name for ease of identification, especially if your organization uses multiple datasources.

The Host is the host name of your Databricks workspace and the Port defaults to the standard SSL/TLS port 443.

The HTTP Path identifies the Databricks compute cluster and the Catalog is the catalog to connect to. A single Databricks datasource can only connect to a single Databricks catalog. Cluvio will fetch schema information for this catalog in order to populate the almanach in the report editor.

For authentication with Databricks Cluvio currently only supports personal access tokens (PAT). To use a PAT, set the Username to token and set the personal access token as the password.

OAuth Machine-to-Machine Authentication

Support for OAuth Machine-to-Machine authentication is planned but not yet supported by Cluvio.

Databricks connections always use verified SSL/TLS connections.

When you have entered all the required information, select Test Connection to check that Cluvio can connect to your Databricks compute cluster. The connection test will report errors if the connection fails. See Troubleshooting for common problems.

Configuration

The Configuration tab of the datasource dialog shows settings that affect the datasource's behavior.

image-600 image-600

The Data Time Zone defaults to UTC and is the time zone that Cluvio assumes for any timestamps returned from queries that do not contain time zone information. See Data Time Zone for details.

The Maximum number of concurrent query executions control the maximum concurrency that Cluvio allows for the datasource. This setting can be used to control the maximum load on your database. The default is 20.

The toggle Update schema nightly controls whether Cluvio queries your database schema nightly to ensure that the almanach in the report editor has up-to-date information on your database schema. Together with fetching schema information, Cluvio also tries to retrieve approximate row counts in each table. If you disable nightly schema updates, the almanach is only updated when you manually trigger a schema refresh on the datasource from the Cluvio datasources overview. Nightly schema updates are enabled by default.

The toggle Update exact row counts is only available when Update schema nightly is enabled. This setting controls whether Cluvio will determine exact row counts for every table in your database schema. Row counts are shown in the report editor almanach. Determining exact row counts usually involves issuing a COUNT(*) query on each table, which may cause undesirable load on your database. You can disable this setting to avoid these nightly queries. When disabled, the tables in the report editor almanach may not show row count information if the database does not provide approximate row counts.

Troubleshooting

If you need help connecting to your Databricks compute cluster, please contact support@cluvio.com.