Skip to Content

Supported connectors

Connect Databricks

Connect a Databricks SQL warehouse.

Before you start

  • You are an Admin or a Developer, or your role has the datasource Connect permission.
  • Your firewall allows Databrain’s outbound IP on the database port. The form shows the IP under Setup guide > Allow the outbound IP. See Allow Databrain’s IP.
  • You have a SQL warehouse. A serverless warehouse starts in seconds.
  • You have a personal access token, or a service principal with an OAuth secret.

Connect

  1. Go to Data Studio > Datasources and select Connect data source.

    Datasources page with the Connect data source button outlined
    Connect data source is at the top right of the Datasources page.
  2. Select Databricks. You can type the name in Search connectors.

    Add datasource page with the Databricks tile outlined
    The Databricks tile on the Add datasource page.
  3. Fill in the form:

    FieldWhat to enter
    Datasource nameHow this datasource appears in lists and pickers, for example Production warehouse.
    Workspace hostYour workspace URL without https://, for example dbc-a1b2345c-d6e7.cloud.databricks.com.
    HTTP pathFrom SQL Warehouses > your warehouse > Connection details, for example /sql/1.0/warehouses/a1b234c5678901d2.
    AuthenticationPersonal access token (then Access token (legacy)). OAuth service principal (then Client ID and OAuth secret) shows only when Databricks OAuth is on for your company. Ask Databrain support to turn it on.
    Query tags (optional)Up to 10 key:value pairs for Databricks query history, for example team:finance,app:databrain.
  4. Select Connect datasource.

Connect Databricks form with the connect button outlined and the Setup guide on the right
Fill in the form, then select the button at the bottom. The Setup guide on the right lists the grants and where each value comes from.

Databrain checks the connection and reads your schema. You see Step 3 of 3 with Model your data. Next, create a datamart.

Grant read access in Unity Catalog

Give the user or service principal Can use on the SQL warehouse (SQL Warehouses > your warehouse > Permissions). Then run this for each schema:

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>`;

Where to find the values

  • Service principal: Settings > Identity and access > Service principals > Add. Open it, then Secrets > Generate secret. Databricks shows the secret once.
  • Workspace host: the address bar when you are signed in to the workspace, without https://.

If something goes wrong

If the check fails, the datasource stays on the form with Needs credentials. Fix the field the message names and select Connect datasource again.

  • The database did not answer in time. A firewall blocks Databrain. Allow the outbound IP on the database port.
  • The database rejected these credentials. Check the username and password, and that the user can sign in from a remote host.
  • The credentials worked, but the user cannot read the catalogue. Run the grants above.

On this page