Skip to main content

How to Set up Databricks

Updated this week

Setup takes about 10-15 minutes.

Introduction

Connecting Databricks to Foundational allows Foundational to extract information from Unity Catalog, notebook widget configurations, and usage metrics.

To make the connection, you need to:

  • Create or assign user credentials

  • Grant the required Databricks privileges

  • Connect Databricks to Foundational using the workspace URL, personal access token, and warehouse ID


Prerequisites

Ensure you have:


Access permissions

Foundational uses these permissions for metadata and usage analysis only.

The permissions you assign to Foundational enable it to:

  • Read metadata from Unity Catalog

  • Read notebook widget configurations

  • Read usage metrics and query history from system tables


Create or assign user credentials

  1. Verify that the Databricks user has access to the relevant workspaces. See the Databricks article on workspaces.

  2. Generate a personal access token (PAT). See the Databricks article on creating PATs and ensure that you:

    • Give the token a descriptive name, e.g., foundational-connector.

    • Set the token to the maximum lifetime of 375 days because if it expires, Foundational cannot ingest information from Databricks.

  3. Save the token before you close the Token Creation dialog box, because it’s only shown once. You’ll need it later to make the connection.

  4. Grant the BROWSE privilege to the user for whom you created the personal access token. See the Databricks article on privileges.

  5. Grant the user permissions for Query History and other relevant tables. Run the following commands:

    GRANT SELECT ON SYSTEM.QUERY.HISTORY TO `<user-name>`;
    GRANT USE SCHEMA ON SCHEMA system.query TO `<user-name>`;

Connect Foundational to Databricks

  1. In Foundational, open the Connectors & Integrations page.

  2. In Warehouses, select the Databricks card and click Connect.

  3. A screen opens. Click Add Workspace.

  4. The initial setup screen opens. Click Start Setup.

  5. The Set Up New Connection screen opens.


    Enter the details:

    • Workspace URL: Open your Databricks workspace and copy the top-level URL from the browser’s address bar.

    • Personal Access Token: The PAT you saved earlier.

    • Warehouse ID (optional): Enter the ID of the warehouse that Foundational uses for ingestion.

  6. Click Next.

  7. The final setup screen opens. To complete the connection, click Save.

That’s it. Foundational is now connected to Databricks.

Did this answer your question?