Databricks

Connect to Databricks SQL warehouses using credentials or a JDBC connection URL

You can connect your Databricks workspace to Livedocs from the Data tab using either individual credentials or a JDBC connection URL.


How to Connect

  1. Go to the Data tab in your workspace.
  2. Click Connect a Database.
  3. In the Database Type dropdown, select Databricks.
  4. Choose your connection method (credentials or URL).
  5. Fill in the required fields.
  6. Click Connect to Databricks.

Option 1: Connect with Credentials (Default)

Required Fields

  • Name – A friendly name for this connection (e.g., Analytics Databricks).
  • Host – Your Databricks workspace hostname (e.g., adb-1234567890123456.7.azuredatabricks.net).
  • HTTP Path – The path to your SQL warehouse (e.g., /sql/1.0/warehouses/abc123def456).
  • Personal Access Token – Your Databricks PAT for authentication.

Optional Fields

  • Port – The connection port (defaults to 443).
  • Default Catalog – The catalog to use by default (e.g., hive_metastore).

Option 2: Connect with URL

Check the Connect using URL checkbox to use a JDBC connection string instead.

  • Connection URL – A full JDBC connection string in the format:
    jdbc:databricks://host:port/path;httpPath=/sql/1.0/warehouses/...
  • Personal Access Token – Your Databricks PAT for authentication.

Finding Your Connection Details

  1. Log in to your Databricks workspace.
  2. Click SQL > SQL Warehouses in the sidebar.
  3. Click your target warehouse’s name.
  4. On the Connection Details tab, copy:
    • Server Hostname (use as Host)
    • Port (typically 443)
    • HTTP Path (e.g., /sql/1.0/warehouses/abc123)

Creating a Personal Access Token

  1. In your Databricks workspace, click your username in the top bar and select Settings.
  2. Click Developer.
  3. Next to Access tokens, click Manage.
  4. Click Generate new token.
  5. Enter a description (e.g., Livedocs Connection).
  6. Set the token’s lifetime (recommended: less than 90 days).
  7. Click Generate and copy the token to a secure location.

Personal access tokens are sensitive credentials. Store them securely and do not share them. If you lose a token, you must generate a new one.


Additional Options

  • Allow Inserts and Updates – Enable this if you want Livedocs to write data to Databricks tables.
  • Don’t Have Credentials? – You can invite a teammate who has access to Databricks to connect it for you.

Next Steps:


Resources:


Need Help? If something goes wrong, contact support@livedocs.com and we’ll get it sorted.