Databricks Connection
The Databricks Connection serves as the gateway between your Gathr application and the Databricks platform. It enables seamless communication and interaction with the Databricks SQL Warehouse for running SQL queries.
Prerequisites
To get the connection details for a Databricks SQL warehouse, do the following:
Log in to your Databricks workspace.
In the sidebar, click SQL > SQL Warehouses.
In the list of available warehouses, click the target warehouse’s name.
On the Connection Details tab, copy the connection details that you need, such as Server hostname, Port, and HTTP path.
Connection Configuration
Configure the fields required to create the connection as explained below.
Connection Name
Name of the connection to be created.
Host Name
Hostname of the Databricks SQL Warehouse instance.
For example,
For more details, see Prerequisites.
Port
The port number associated with the Databricks SQL Warehouse instance. Default port value is 443.
For more details, see Prerequisites.
HTTP Path
HTTP Path of the Databricks SQL warehouse instance.
For more details, see Prerequisites.
Personal Access Token
The personal access token of your Databricks workspace user.
To know more about Databricks personal access tokens for workspace users, click here.
Advanced Configurations
This section contains advanced configuration parameters.
Auto Start Databricks SQL Warehouse
Enabling this option allows you to start the Databricks SQL Warehouse at application runtime, if it is not running. This can be useful to ensure that the SQL Warehouse is available when needed without manual intervention.
SQL Warehouse Action
Enabling this option allows you to start the Databricks SQL Warehouse at runtime if it is not running. This can be useful to ensure that the SQL Warehouse is available when needed without manual intervention.
Specify the action to be taken once the SQL Warehouse is initiated.
Possible values are:
Start: The SQL Warehouse is initiated and begins execution. But it remains operational even after the job is completed.
Start and Stop: The SQL Warehouse is initiated and begins execution. However, it will automatically stop once the job is completed, optimizing resource utilization.
Be careful when you set this option for the Databricks SQL Warehouse while executing multiple jobs with the same connection to prevent unintended disruptions during execution.Suppose multiple applications run simultaneously using the same Databricks connection with this option enabled. In that case, the automatic SQL Warehouse termination after the first application’s completion can impact subsequent jobs from other applications. The SQL Warehouse termination will cause them to fail.
After entering all the details, click on the TEST button.
If the connection service identification and authentication details are provided correctly, a success message stating “connection available” is generated. Click on the CREATE button to save the changes.
If the details are incorrect or the server is down, you will get a message “Connection unavailable”.
If you have any feedback on Gathr documentation, please email us!