Supper

Integration guide · Databricks

Linking Databricks to Supper.

Supper connects to your data in Databricks through a SQL Warehouse, authenticated with a Personal Access Token. Five fields, six steps, read-only by design.

This walkthrough takes you from a fresh Databricks workspace to a live connection in Supper. You'll create or pick a SQL Warehouse, generate a token, grant read access on the catalog and schema you want Supper to query, and paste it all into the Sources tab. Nothing here writes to your data.

Connect source · Databricks read-only
Workspace Hostyour databricks hostname
dbc-a1b2c3d4-e5f6.cloud.databricks.comStep 1
HTTP Pathsql warehouse connection
/sql/1.0/warehouses/a7f3c9d2e1b4f6a8Step 2
Personal Access Tokenpat tied to a user or service principal
dapi••••••••••••••••••••••••Step 3
Catalogunity catalog catalog name
mainStep 5
Schema (Database)schema to query
analytics_prodStep 5
[ Step by step ]
1

Identify your Workspace Host

Your Databricks workspace URL is your host. You'll find it in your browser's address bar whenever you're logged into Databricks. Use only the hostname — no https:// and no trailing slash.

# format
dbc-xxxxxxxx-xxxx.cloud.databricks.com
2

Create or identify a SQL Warehouse

Supper queries Databricks through a SQL Warehouse (formerly a SQL Endpoint).

  • In the Databricks sidebar, go to SQL Warehouses.
  • Select an existing warehouse, or click Create SQL Warehouse.
  • Once it's running, open it and go to the Connection details tab.
  • Copy the HTTP Path.
# http path
/sql/1.0/warehouses/xxxxxxxxxxxxxxxx

Choose a warehouse sized appropriately for your query load.

3

Generate a Personal Access Token (PAT)

Supper authenticates with a PAT tied to a Databricks user or service principal. To generate one for your user:

Settings → Developer → Access tokens
  • Click your username in the top-right corner, then open the path above.
  • Click Generate new token, then add a description and set an expiration.
  • Under Scope, select BI Tools — this adds the sql API scope — then click Generate.
  • Copy the token. It starts with dapi and is shown only once.

Recommended: use a dedicated service principal instead of a personal account. Create one under the path below, grant it permissions, and generate a PAT the same way.

Settings → Identity and access → Service principals
4

Grant permissions

The user or service principal behind the PAT must be able to read the data Supper will query. At minimum:

  • USE CATALOG on the target catalog.
  • USE SCHEMA on the target schema.
  • SELECT on the tables and views Supper should read.

Grant these via the Catalog Explorer (Unity Catalog), or with SQL:

GRANT USE CATALOG ON CATALOG <catalog> TO <principal>;
GRANT USE SCHEMA ON SCHEMA <catalog>.<schema> TO <principal>;
GRANT SELECT ON SCHEMA <catalog>.<schema> TO <principal>;
5

Identify your Catalog and Schema

Catalog

The Unity Catalog catalog that contains your data — for example workspace, main, or a custom name. Find it in Catalog Explorer.

Schema (Database)

The schema within that catalog that Supper should query — for example default or analytics_prod.

Supper reads tables and views within this catalog + schema combination.

6

Enter credentials in Supper

  • Navigate to the Sources tab and click Connect Source.
  • Select Databricks.
  • Fill in the five fields: Workspace Host (Step 1), HTTP Path (Step 2), PAT (Step 3), Catalog and Schema (Step 5).
  • Review your entries, then click Save to confirm.
[ Good to know ]

The PAT is a long-lived credential. Store it securely and rotate it periodically. If you rotate it, update Supper to avoid connection interruptions.

Supper can access only the catalog and schema you specify. It cannot read outside that scope unless you grant additional permissions.

All of the above can be automated via the Databricks Terraform provider or the Databricks CLI.

Stuck on a step? We'll connect it with you.

Send us your workspace setup and we'll walk through the warehouse, token, and grants together — usually live, in one short call.

Talk to our team Learn more about Supper →
SQL Warehouse Unity Catalog Personal Access Token Service principal Read-only by design Terraform / CLI ready