Databricks

As a best practice, generate a dedicated Databricks Personal Access Token scoped only for your chosen catalog (Hive or Unity) and use it against your workspace host. This isolates your integration credentials and simplifies permission management, ensuring a seamless no-code connection.

Prerequisites

• Host

• Personal Access Token

• (Conditional) Hive catalog:

  • SQL Warehouse HTTP Path or Cluster ID

• (Conditional) Unity Catalog:

  • SQL Warehouse HTTP Path

---

Host

Your Host is the domain portion of your Databricks workspace URL.

When you log into Databricks, your browser URL looks like: https://<workspace-name>.cloud.databricks.com/?o=1234567890123456 Use only <workspace-name>.cloud.databricks.com (no protocol, no path, no query string).

• ✅ mycompany.cloud.databricks.com

• ❌ https://mycompany.cloud.databricks.com

• ❌ mycompany.cloud.databricks.com/?o=1234567890123456

---

Personal Access Token

Databricks uses a Personal Access Token for API and notebook authentication.

How to generate a token:

1. Click your user avatar (top-right) → User Settings → Access Tokens.

2. Click Generate New Token, give it a name, set an expiration.

3. Copy the token value — you won’t see it again.

⚠️ Warning:

• Treat this token like a password. Don’t check it into source control.

• Store it in environment variables or a secure vault.

• ✅ dapiXXXXXXXXXXXXXXXXXXXX - expected format of Databricks access token.

• ❌ (leaving blank) — connection will fail.

---

Catalog Selection (Conditional Fields)

Databricks supports two catalog types. Fill only the fields required for your chosen catalog.

Hive Catalog

Use Hive catalog when connecting to classic clusters or SQL Warehouses without Unity Catalog.

• If you’re using a SQL Warehouse, supply the SQL Warehouse HTTP Path:Tip:

  1. In Databricks UI, go to SQL → SQL Warehouses.

  2. Click your warehouse → Connection Details → copy the JDBC/ODBC HTTP Path.

• ✅ /sql/1.0/warehouses/abcdef1234567890 - expected HTTP path format.

• ❌ (cluster IT path or cluster ID)

• If you’re using a standard (compute) cluster, supply the Cluster ID instead:Tip:

  1. In Databricks UI, go to Compute → Clusters.

  2. Click your cluster name → copy the Cluster ID from the URL or details.

• ✅ 1234-567890-abcd123 - expected cluster ID.

• ❌ /sql/1.0/warehouses/abcdef1234567890 - do not use HTTP path as cluster ID.

⚠️ Warning:

• Provide either SQL Warehouse HTTP Path or Cluster ID — not both.

• If both are filled, the connection may default to the wrong endpoint.

Unity Catalog

Use Unity Catalog when your data lives under the Databricks Unity Catalog model.

• SQL Warehouse HTTP Path is required.

In SQL → SQL Warehouses, select a warehouse that’s enabled for Unity Catalog, then copy its HTTP Path as above.

• ❌ Do not enter a Cluster ID when using Unity Catalog.

---

4. Putting It All Together

Below is an example configuration for each scenario:

Example: Hive Catalog + SQL Warehouse

host: mycompany.cloud.databricks.com
token: dapiXXXXXXXXXXXXXXXXXXXX
sql_warehouse_http_path: /sql/1.0/warehouses/abcdef1234567890
cluster_id: # leave blank

Example: Hive Catalog + Standard Cluster

host: mycompany.cloud.databricks.com
token: dapiXXXXXXXXXXXXXXXXXXXX
sql_warehouse_http_path: # leave blank
cluster_id: 1234-567890-abcd123

Example: Unity Catalog

host: mycompany.cloud.databricks.com
token: dapiXXXXXXXXXXXXXXXXXXXX
sql_warehouse_http_path: /sql/1.0/warehouses/uvwxyz9876543210
cluster_id: <left empty>