Databricks can be used in two ways on the Harbr platform:
-
Databricks Workspace Connector (Azure only) — connects Harbr to a Databricks workspace to bring data on and off the platform. Supports the full range of platform features including Export, Query and Spaces.
-
At-Source Connector (AWS) — configures Databricks as a source for At Source assets, enabling Delta Shares. As of version 5.31, Export and Spaces can also be enabled on certain environments.
1. Databricks Workspace Connector (Azure only)
Pre-requisites
-
Unity Catalog enabled on your Databricks Workspace
-
A Databricks Managed Service Account (Entra accounts are not supported)
-
A Harbr account with one of the following roles: Default User, Organisation Admin, or Technician
Databricks account permissions required:
|
Permission |
Status |
|---|---|
|
Clusters |
CAN_MANAGE |
|
Jobs |
CAN_MANAGE |
|
Cluster Policies |
CAN_MANAGE |
|
DLT |
CAN_MANAGE |
|
Directories |
CAN_MANAGE |
|
Notebooks |
CAN_MANAGE |
|
Queries |
CAN_MANAGE |
|
Alerts |
CAN_MANAGE |
|
Secrets |
CAN_MANAGE |
|
Token |
CAN_MANAGE |
|
SQL Warehouse |
CAN_READ |
|
Repos |
CAN_MANAGE |
|
Pools |
CAN_MANAGE |
|
ML Models |
Not required |
|
ML Experiments |
Not required |
|
Dashboard |
Not required |
Requirements may vary depending on which Harbr features you intend to use. Consult your Harbr contact before configuration.
PAT token or OAuth credentials must also have:
-
USE CATALOGon any catalogs you want to create assets from -
USE SCHEMAon relevant schemas -
SELECTat catalog, schema or table/view level -
READ VOLUMEat catalog, schema or volume level -
Workspace accessandDatabricks SQL access(defaulted ON when creating a user from inside the workspace)
The service account must also have Can Use permissions for Use Tokens (Workspace Admin Settings → Permission Settings).
Create the Connector
-
Click Manage on the Navigation bar
-
Select Connectors → Create connector
-
Enter a Name and optional Description
-
Select Type → Databricks
-
Select authentication method:
-
PAT token — generated in Developer Settings in Databricks (guide). Only Databricks personal token authentication is supported.
-
OAuth — using a service account. Ensure required permissions are granted on catalogs, schemas and SQL Warehouses.
-
-
Enter Host — the workspace URL e.g.
https://adb-1535878582058128.8.azuredatabricks.net(no trailing/) -
Enter Client ID — generated in Azure (Service Principal UUID)
-
Enter Client Secret Value — visible once on generation in Azure
-
Set the
httpPath:-
In Databricks: Compute → SQL Warehouses → select warehouse → Connection Details → copy HTTP Path (e.g.
/sql/1.0/warehouses/7cff6770269b80c7)
-
-
Click Create
Note: Adding the httpPath is a mandatory step and the connector setup will fail if it isn’t configured.
No minimum cluster size is required — Small or Medium is sufficient. The platform will start and stop the warehouse; Auto Stop can be configured. No scaling is required.
Identity Configuration
The service account must:
-
Be added as a user (or in a group) in your Databricks workspace
-
Have Databricks SQL Access entitlement enabled
-
Have
USE CATALOGon each relevant catalog -
Have
USE SCHEMAon relevant schemas -
Have
SELECTon each table to be read -
Have Can Use permission on the designated SQL Warehouse
-
Have Can Use permissions for Use Tokens (Workspace Admin Settings → Permission Settings)
Recommendation: Use a serverless SQL Warehouse — it starts automatically when needed. Non-serverless warehouses must be running before testing the connector or creating/exporting assets.
Integration Metadata Reference
|
Key |
Required |
Purpose |
How to find |
|---|---|---|---|
|
|
Yes (for copy/export) |
Identifies the SQL Warehouse for asset copy and export |
Compute → SQL Warehouses → Connection Details |
|
|
Only for WoG Catalog |
Matches the Databricks metastore for automatic asset creation |
Data → Unity Catalog settings |
|
|
Only if network-restricted |
Disables Cloud Fetch via Azure Storage where egress is blocked |
Set to |
Configure Organisations
Each organisation can use a different Databricks warehouse. To configure:
-
Go to Organisation Administration → Metadata
-
Add the following key/value pair:
Key: harbr.user_defaults
Value:
{
"consumption": {
"catalogs": [
{
"name": "",
"id": "",
"connector_id": "",
"databricks_catalog": "assets",
"databricks_schema": "managed",
"databricks_table_name": { "naming_scheme": "PESSIMISTIC" },
"default": true,
"access": {
"share": { "default_ttl_minutes": "1200" },
"query": { "default_llm": "", "default_engine": "" },
"iam": {}
}
}
]
},
"upload_platform": { "connector_id": "yourconnectorid" },
"processing_platform": {
"connector_id": "yourconnectorid",
"default_job_cluster_definition": {}
}
}
2. At-Source Connector (AWS)
At Source assets can be created from an appropriately configured Databricks connector and used to create Delta Shares, Exports and within Spaces (as of 5.31 - enabled independently per environment.
Limitations vs. the Workspace Connector:
-
Sample Data returns the first rows of a table rather than a random sample
-
Metadata size is estimated rather than calculated from a full table scan
Pre-requisites & Permissions
Both PAT and OAuth can be used. The service principal account requires the following metastore-level permissions:
|
Permission |
Purpose |
|---|---|
|
|
Define external data share recipients from the marketplace |
|
|
Create new data shares on the above recipients |
|
|
Use existing share recipients in Unity Catalog (Databricks-to-Databricks shares only) |
|
|
Grant or revoke share-level permissions on marketplace shares |
Configuration Steps
-
Ensure Data Sharing is enabled on the platform
-
Set
httpPathon the connector:-
In Databricks: SQL Warehouses → select warehouse → Connection Details → HTTP Path (e.g.
/sql/1.0/warehouses/024ad5865e6bc94d)
-
Note: Adding the httpPath is a mandatory step and the connector setup will fail if it isn’t configured.
3. Spaces and Export on AWS (5.31)
Available on AWS, enabled independently per environment and off by default. Ask your Harbr representative to turn this on for your platform.
At-source Databricks tabular assets can now be queried interactively in Spaces and included in Export jobs on platforms with an AWS dataplane, in addition to the existing Delta Sharing consumption path. Nothing is copied until a query runs or an export is triggered.
-
In Spaces, queries run through Harbr's Trino engine directly against your Databricks SQL warehouse, so warehouse compute is only used while a query is running.
-
In Export, a Glue job reads the data via the Databricks driver at export time.
-
Spaces and Export are enabled independently — turning one on does not turn on the other.
-
No Databricks account administrator action is required to enable this. Setup is cloud-side only (an AWS IAM role and trust policy); Harbr provisions the Unity Catalog storage credential automatically when the connector is saved.
-
Both personal-access-token and OAuth machine-to-machine Databricks connectors are supported. For OAuth, Harbr mints a short-lived token so the client secret never leaves the platform.
-
A reader-agnostic browser download is also introduced alongside this: an at-source asset (Databricks or Snowflake) can now be downloaded as a packaged ZIP.
Existing at-source assets need a usage-type recalculation after this is enabled before Spaces/Export options appear for them. Ask your Harbr representative if you don't see the option after enabling.