Databricks SQL dashboards

Preview

This feature is in Public Preview.

A Databricks SQL dashboard lets you combine visualizations and text boxes that provide context with your data.

View the list of saved dashboards

To see a list of saved dashboards, click Dashboards Icon Dashboards in the sidebar. By default, dashboards are sorted in reverse chronological order by the Created By column. You can reorder the list by clicking the column headings.

Filter the list of saved dashboards

You can filter the list of dashboards by the list of dashboards that you created (My Dashboards), by favorites, and by tags.

Create a dashboard

Follow these steps to create a new dashboard. To clone an existing dashboard, see Clone a dashboard.

  1. Do one of the following:

    • Click Create Icon Create in the sidebar and select Dashboard.
    • Click Dashboards Icon Dashboards in the sidebar and click the + New Dashboard button.
    • If you don’t want to start from an empty dashboard, you can create a quick dashboard:
      1. Click Data Icon Data in the sidebar.
      2. Browse to the table, then click Create > Quick Dashboard.
      3. In the configuration page, select columns of interest and create a dashboard and supporting queries that provide some basic information using those columns and showcase dashboard-level parameters and other capabilities.
      4. Continue with the following steps to customize the dashboard.
  2. Enter a name for the dashboard.

  3. Add content to the dashboard:

    • Click Add Textbox to add commentary.

      Enter text. You can style the text boxes using Markdown. To include static images within text boxes on your dashboards, use Markdown image syntax:![alt-text](<image-url>).

    • Click Add Widget to add a query visualization.

      1. Select a query. Search existing queries or pick a recent one from the pre-populated list.

      2. In the Choose Visualization drop-down, select the visualization type.

        Add to dashboard
  4. Click Add to Dashboard.

    Add widget to dashboard
  5. Drag and drop content blocks on the dashboard.

  6. Click Done Editing.

    Complete dashboard

Clone a dashboard

If you have the Can Run, Can Edit, and Can Manage permissions on a dashboard and each of its upstream queries, you can clone the dashboard and all upstream queries. You become the owner of the new dashboard and queries.

Important

Sharing settings, alerts, and subscriptions are not copied to the new dashboard.

To clone a dashboard:

  1. Open the vertical ellipsis Vertical Ellipsis at the top-right of the dashboard and select Clone.
  2. Enter a name for the new dashboard, then click Confirm.

Remove content from a dashboard

  1. Click the vertical ellipsis Vertical Ellipsis at the top-right of the widget and select Remove from Dashboard.
  2. Click Delete.

Edit a dashboard

To open the dashboard for editing, open the vertical ellipsis Vertical Ellipsis at the top-right of the dashboard and select Edit.

Edit dashboard

While editing you can add and remove content and apply filters.

Add content to a dashboard

  1. Open the dashboard for editing.
  2. Click Add Textbox or Add Widget.
  3. Click Add to Dashboard.
  4. Click Done Editing.

You can also add a visualization to a dashboard in the SQL editor.

Remove content from a dashboard

  1. Click the SQL Delete Icon or hover over the object, click the vertical ellipsis Vertical Ellipsis at the top-right of the widget and select Remove from Dashboard.
  2. Click Delete.

Dashboard filters

When queries have filters you must also apply filters at the dashboard level. Select the Use Dashboard Level Filters checkbox to apply the filter to all queries.

Refresh a dashboard

Dashboards should load quickly because they fetch their data from a cache that renews whenever a query runs. But if you haven’t run the queries recently, your dashboard might be stale. It could even mix old data with new if some queries ran more recently than others.

Manually refresh a dashboard

To force a refresh, click the Refresh button on the top right of the dashboard. This runs all the dashboard queries and updates its visualizations.

Automatically refresh a dashboard

A dashboard’s owner and users with the Can Edit permission can configure a dashboard to automatically refresh on a schedule. To automatically refresh a dashboard:

  1. Click the Schedule button at the top right of the dashboard. The scheduling dialog appears.

    Dashboard subscription
  2. In the Refresh every drop-down, select a period.

  3. In the SQL Endpoint drop-down, optionally select a SQL endpoint to use for all the queries. If you don’t select an endpoint, the queries execute on the last used SQL endpoint.

  4. Next to Subscribers, optionally enter a list of email addresses to notify when the dashboard is automatically updated.

    Each email address you enter must be associated with a Databricks account or configured as an alert destination.

  5. Click Save. The Schedule button label changes to Scheduled.

Dashboard snapshot subscriptions

You can periodically export and email dashboard snapshots. Dashboard snapshots are taken from the default dashboard state, meaning that any interaction with the filters and visualizations is not present in the snapshot.

If you are the owner of a dashboard or if you have the Can Edit permission, you can create a refresh schedule and subscribe other users, who will receive email snapshots of the dashboard every time it’s refreshed.

Note

If you have the Can Edit permission, you are limited to subscribing users who already have access to the dashboard, or subscribing alert destinations that are already configured. If you have the Can Manage permission, you can subscribe any user with access to the workspace.

To add subscribers, enter one or more email addresses for dashboard users or alert destinations in the Subscribers field.

If you have the Can View or Can Edit permission for a dashboard, you can subscribe to existing refresh schedules. To subscribe, click the Subscribe button.

Subscribe to dashboard

Temporarily pause scheduled dashboard updates

If a dashboard is configured for automatic updates, it has a Scheduled button at the top, rather than a Schedule button. You can temporarily pause dashboard updates and scheduled export to subscriptions. This is helpful to avoid sending updates while testing changes to the dashboard. To temporarily pause scheduled dashboard updates without modifying the list of subscribers:

  1. Click Scheduled.
  2. Click the Enabled toggle.
  3. Click Save.

Stop automatically updating a dashboard

If a dashboard is configured for automatic updates, it has a Scheduled button at the top, rather than a Schedule button. To stop automatically updating the dashboard and remove its subscriptions:

  1. Click Scheduled.
  2. In the Refresh every drop-down, select Never.
  3. Click Save. The Scheduled button label changes to Schedule.

Download as PDF

To download a dashboard as a PDF file, click the vertical ellipsis Vertical Ellipsis at the top-right of the dashboard and select Download as PDF.

Move a dashboard to Trash

To move a dashboard to Trash, click the vertical ellipsis Vertical Ellipsis at the top-right of the dashboard and select Move to Trash. Confirm by clicking Move to Trash.

Restore a dashboard from Trash

  1. Click Dashboards Icon Dashboards in the sidebar.
  2. Click Trash Button.
  3. Click a dashboard.
  4. Click the vertical ellipsis Vertical Ellipsis at the top-right of the dashboard and select Restore.

Permanently delete a dashboard

  1. In the All Dashboards list, click Trash Button.
  2. Click a dashboard.
  3. Click the vertical ellipsis Vertical Ellipsis at the top-right of the dashboard and select Delete.

Open a query

To open the query displayed in a widget in the SQL editor, click the vertical ellipsis Vertical Ellipsis at the top-right of the widget and select View Query.

Configure dashboard permissions

To configure who can manage and run dashboards, see Dashboard access control.

Access admin view

A Databricks admin user has view access to all dashboards. In this view an admin can view and delete any dashboard. However, an admin can’t edit a dashboard if it is not shared with the admin.

To view all dashboards:

  1. Click Dashboards Icon Dashboards in the sidebar.
  2. Click Admin View on the right panel.

Transfer ownership of a dashboard

If a dashboard’s owner is removed from a workspace, the dashboard no longer has an owner. An admin user can transfer ownership of a dashboard to a different user. To transfer ownership by using the Databricks SQL UI:

  1. Open the dashboard.
  2. Click Share.
  3. Click Assign new owner.
  4. Select the new user you’d like to make the owner from the dropdown and click Confirm.

To transfer ownership by using the REST API, see Transfer ownership of a dashboard.

If the dashboard previously had an owner, that user no longer has the Can Manage permission on the dashboard, and the user to whom you gave the Can Manage permission is now the owner.

If the dashboard previously had an owner, that user no longer has the Can Manage permission on the dashboard. The user you gave the Can Manage permission is now the owner.