Skip to main content

Databricks

Databricks is a unified data analytics and lakehouse platform built on Apache Spark that combines data warehousing, data engineering, machine learning, and analytics capabilities. This integration provides comprehensive access to Databricks Unity Catalog and workspace metadata, enabling organizations to query, inventory, monitor, and govern their data platform resources, infrastructure, and configurations.

CategoryData warehouse
DirectionQuery source
Sign-inPersonal Access Token, OAuth Service Principal, Basic Authentication, Databricks CLI Config File
Query languagesSQLite
Tables51
Query templates362
Websitedatabricks.com

Before you start​

Huntbase can sign in to Databricks with any of these methods: Personal Access Token, OAuth Service Principal, Basic Authentication, Databricks CLI Config File. Pick one, create the credential in Databricks, then keep it to hand for the Connect step.

Personal Access Token​

Databricks workspace Personal Access Token or account SCIM token

  1. In your Databricks workspace, click your user name in the top bar and select Settings.
  2. Click Developer, then click Manage next to Access tokens.
  3. Click Generate new token, enter a name, and set the token's lifetime in days.
  4. Click Generate, copy the token, then click Done.

OAuth Service Principal​

OAuth machine-to-machine (M2M) authentication using a service principal client ID and client secret.

  1. As a workspace admin, click your user name in the top bar and select Settings › Identity and access. Next to Service principals, click Manage.
  2. Click Add service principal › Add new, enter a name, and click Add.
  3. Select the service principal, open the Secrets tab, and click Generate secret.
  4. Set the secret's lifetime in days (up to 730). Under Scopes, select only the API scopes you need rather than all APIs.
  5. Click Generate, copy the secret and the client ID, then click Done.
Watch out for
  • An OAuth secret is shown only once. If you lose it, generate a new one. A service principal can have up to five secrets.
  • If you can't create a personal access token, your workspace admin may have disabled tokens or restricted who can use them.
  • Basic authentication with a user name and password only works for workspaces on *.cloud.databricks.com (AWS).

For the vendor's own instructions, see Databricks OAuth machine-to-machine authentication.

tip

Use a dedicated, read-only credential for Huntbase where the product allows it. Huntbase only needs to read.

Connect Databricks​

  1. Go to Connections and click New connection, or click New connection on the Databricks product page.
  2. On Product, pick Databricks and choose the Owner.
  3. On Details, give the connection a Name and, optionally, a Description.
  4. On Connect, fill in the settings and credentials described below.
  5. On Verify, review the summary and click Create & check.

For everything else on the setup page — saving a draft, I'll do this later, and what each check result means — see Connections.

Settings​

Where your Databricks lives:

FieldRequiredNotes
Config ProfileNo
Account IDNoYour Databricks account ID. Only needed for account-level data, together with the Account Console URL.
Account Console URLNoThe account console URL, typically https://accounts.cloud.databricks.com. Only needed for account-level data.
Workspace URLNoYour workspace URL, such as https://dbc-a1b2c3d4-e6f7.cloud.databricks.com.
Config File PathNo
OAuth Client IDNoThe service principal's application ID, shown with the secret when you generate it.

Credentials​

Choose a Method, enter a Credential label (for example Production), then fill in the fields for that method.

Personal Access Token​

FieldRequiredNotes
Workspace Personal Access TokenYesSecret — not shown again after you save it.
Account SCIM TokenNoSecret — not shown again after you save it.

OAuth Service Principal​

FieldRequiredNotes
OAuth Client SecretYesSecret — not shown again after you save it.

Basic Authentication​

FieldRequiredNotes
UsernameYesSecret — not shown again after you save it.
PasswordYesSecret — not shown again after you save it.

Databricks CLI Config File​

No fields — choose this method to connect without credentials.

Query it​

Once connected, Databricks can serve these languages in a query tab, and Scout can use it when you ask in Auto:

LanguageUse it for
SQLiteSQL over the 51 tables listed below, alongside every other connected source.

Example: SQLite​

List Databricks IAM groups basic info — Explore which user groups exist within your Databricks account, including their unique identifiers and display names, to manage and control access effectively.

select
id,
display_name,
account_id
from
databricks_iam_group;

Databricks ships with 362 query templates. Find them in Library › Queries — see Query templates.

Tables​

Databricks adds 51 tables. Browse their columns from Schema in the query bar's ⋯ menu.

All 51 tables
TableContains
databricks_catalogGets an array of catalogs in the metastore.
databricks_catalog_connectionGets an array of connections for the workspace.
databricks_catalog_external_locationGets an array of external locations from the metastore.
databricks_catalog_functionList functions within the specified parent catalog and schema.
databricks_catalog_metastoreGets an array of the available metastores.
databricks_catalog_schemaList schemas for a catalog in the metastore.
databricks_catalog_storage_credentialGets an array of storage credentials.
databricks_catalog_system_schemaGets an array of system schemas for a metastore.
databricks_catalog_tableGets an array of the available tables.
databricks_catalog_volumeGets an array of the available volumes.
databricks_compute_clusterGets a list of clusters.
databricks_compute_cluster_node_typeReturns a list of supported Spark node types.
databricks_compute_cluster_policyGets an array of cluster policies.
databricks_compute_global_init_scriptGets a list of all global init scripts for this workspace.
databricks_compute_instance_poolGets a list of instance pools with their statistics.
databricks_compute_instance_profileList the instance profiles that the calling user can use to launch a cluster.
databricks_compute_policy_familyRetrieve a list of policy families.
databricks_files_dbfsList the contents of a directory, or details of the file.
databricks_iam_account_groupList group details associated with a Databricks account.
databricks_iam_account_userList details for all the users associated with a Databricks account.
databricks_iam_current_userGets details for the current user of the workspace.
databricks_iam_groupList group details associated with a Databricks workspace.
databricks_iam_service_principalList the set of service principals associated with a Databricks workspace.
databricks_iam_userList details for all the users associated with a Databricks workspace.
databricks_jobGet details for all the jobs associated with a Databricks workspace.
databricks_job_runList details for all the job runs.
databricks_ml_experimentGet details for all the experiments associated with a Databricks workspace.
databricks_ml_modelList all available registered models.
databricks_ml_webhookList all registry webhooks.
databricks_pipelineList pipelines defined in the Delta Live Tables system.
databricks_pipeline_eventRetrieves events for a pipeline.
databricks_pipeline_updateList updates for an active pipeline.
databricks_serving_serving_endpointList all serving endpoints.
databricks_settings_ip_access_listGets all IP access lists for the specified workspace.
databricks_settings_tokenList all the valid tokens for a user-workspace pair.
databricks_settings_token_managementList all tokens associated with the specified workspace or user.
databricks_sharing_providerGets an array of available authentication providers.
databricks_sharing_recipientGets an array of all share recipients within the current metastore.
databricks_sharing_shareList all data object shares from the metastore.
databricks_sql_alertGets a list of alerts.
databricks_sql_dashboardGets details for all the dashboards associated with a Databricks workspace.
databricks_sql_data_sourceRetrieves a full list of SQL warehouses available in this workspace.
databricks_sql_queryGets a list of queries.
databricks_sql_query_historyList the history of queries through SQL warehouses.
databricks_sql_warehouseGets a list of warehouses.
databricks_sql_warehouse_configGets the workspace level configuration that is shared by all SQL warehouses in a workspace.
databricks_workspaceList all secret workspaces available in the workspace.
databricks_workspace_git_credentialLists the calling user's Git credentials.
databricks_workspace_repoReturns repos that the calling user has Manage permissions on.
databricks_workspace_scopeList all secret scopes available in the workspace.
databricks_workspace_secretList the secret keys that are stored.

Next steps​