Guide to integrate Databricks with Sprinkle

This page covers the details about integrating Databricks with Sprinkle.

When setting up Databricks connection, Sprinkle additionally requires a Cloud bucket. This guide covers the role of all the components and steps to setup.

  • Integrating Databricks: All analytical data is stored and queried from Databricks warehouse

  • Cloud Bucket: Sprinkle stores all intermediate data and report caches in this bucket

Step by Step Guide

Integrating Databricks

STEP-1: Allow Databricks to accept connection from Sprinkle

Allow inbound connection on databricks jdbc port (default is 443) from Sprinkle IPs (,

STEP-2: Configure Databricks Connection on Sprinkle

To get the connection details for a Databricks cluster, do the following:

  1. Log in to your Databricks workspace.

  2. In the sidebar, click Compute.

  3. In the list of available clusters, click the target cluster’s name.

  4. On the Configuration tab, expand Advanced options.

  5. Click the JDBC/ODBC tab.

  6. Copy the connection details that you need, such as Server Hostname, Port, and HTTP Path.

  • Log into Sprinkle application

  • Navigate to Admin -> Warehouse -> New Warehouse Connection

  • Select Databricks

  • In the Connect Warehouse form in Sprinkle, provide all the mandatory details

    • Distinct Name: Name to identify this connection

    • Host: Provide the IP address or hostname of your Databricks instance.

    • Port: Provide the port number for your Databricks instance.

    • Database: Provide the name of the specific database you want to connect to within Databricks, if applicable. This should be an existing database

    • HTTP Path: Provide the HTTP path component of your Databricks cluster connection URL. This path identifies the specific Databricks instance you're trying to access.

    • Username: The username (ID) you use to log in to data bricks.

    • Password: Personal access token. To generate, see here.

    • Storage Mount Name: Storage that will be used by Databricks. See the section for more details.

  • Test Connection

  • Create

Creating Storage Mount

Go to Databricks home page and click on the create button on the right side and select notebook. Select the cluster you want to configure with sprinkle and select python as default language.

Run this Python code

Depending on your Cloud, you can create the mount. Sprinkle currently supports Databricks in Azure and AWS clouds.

Azure blob


  source = "wasbs://<container-name>@<storage-account-name>",
  mount_point = "/mnt/<mount-name>",
  extra_configs = {"<storage-account-name>":"<storage key>"})



AccessKey = "<Access_Key>"
SecretKey = "<Secret_Key>"
SecretKey = SecretKey.replace("/", "%2F")
aws_bucket_name = "<Bucket_Name>"
mount_name = "<mount_name>"
dbutils.fs.mount("s3a://%s:%s@%s" % (AccessKey, SecretKey, aws_bucket_name), "/mnt/%s" % mount_name)
display("/mnt/%s" % mount_name))


  1. Storage configured and Storage mount on data bricks should be on the same bucket

  2. Give a unique Storage Mount name and it should not collide with existing mounts. (If path name is /mnt/sprinkle then just mention sprinkle)

  3. Need to set this property "" to True in databricks.

Create a Cloud Bucket

Cloud bucket can be created depending on your Databricks Cloud. Sprinkle supports creating a bucket in AWS or Azure. Refer respective documents for creating a configuring the Cloud Bucket.

Last updated