This quickstart shows you how to import and interact with dashboards in the Databricks SQL Sample Dashboard Gallery. These dashboards illustrate some of the rich visualizations that Databricks SQL provides for gaining insights from your data. No setup is required. These dashboards use data that is already available to your workspace and rely on a compute resource (called a SQL endpoint) that is already configured. You don’t need to be an administrator to get started.
Your Databricks account must be on the Premium plan or above.
Your Databricks workspace must be on the E2 version of the Databricks platform. For information about creating E2 workspaces, see Create and manage workspaces using the account console. All new Databricks accounts and most existing accounts are now E2. If you are not sure which account type you have, contact your Databricks representative.
The user who performs these steps must have the Databricks SQL access entitlement.
All users in new workspaces have this entitlement. To verify that you have this entitlement, use the sidebar persona switcher to select SQL. If you see a padlock next to SQL, ask a workspace administrator to grant the Databricks SQL access entitlement to you.
If your workspace was enabled for Databricks SQL during the Public Preview—that is, before the week beginning September 7, 2021—you retain the entitlement assigned before that date, unless a workspace administrator changes it. In other words, if you did not have the Databricks SQL access entitlement during the Public Preview, you will not have it now unless an administrator gives it to you.
When you log in to Databricks SQL, your landing page looks like this:
If the Databricks Data Science & Engineering or Databricks Machine Learning environment displays, use the sidebar to switch to Databricks SQL.
If you see a padlock next to SQL, ask an administrator to grant the Databricks SQL access entitlement to you.
In the sidebar, click Dashboards
If your workspace has any saved dashboards, they are listed.
Scroll to the bottom of the page. In the Sample Dashboards tile, click Visit gallery. The Dashboard Samples Gallery page appears.
You can also navigate to the Sample Dashboard Gallery by appending
/sql/dashboards/samples/to your workspace URL.
Next to Retail Revenue & Supply Chain, click Import. The dashboard is imported into your workspace, and you are the owner.
The imported dashboard appears, and its visualizations are refreshed.
You can import a sample dashboard multiple times, and multiple users can each import it. You can also import the NYC Taxi Trip Analysis dashboard.
The following sections illustrate some key points about dashboards, using the Retail Revenue & Supply Chain dashboard you just imported.
Each visualization in a dashboard is the result of a query. In the imported dashboard, hover over the National Revenue Trends visualization, then click the context menu, which looks like three vertical dots. Click View Query.
The SQL editor appears with the visualization’s query displayed.
At the top of the query, notice the statement
USE CATALOG SAMPLES;
The sample dashboards use data in the
SAMPLEScatalog, which is separate from data within your workspace. The
SAMPLEScatalog is available to every workspace, but is read-only.
At the bottom of the query, change
LIMIT 500to return only 500 records. Click Run to run the modified query, then click Save to save the query in the dashboard.
When you modify the imported dashboard, the original dashboard in the Dashboard Samples Gallery is not modified. To start over, you can re-import the dashboard.
Click the browser’s Back button to go back to the dashboard.
Hover over the Shifts in Pricing Priorities visualization. At the bottom, click the button at the right to expand the visualization.
Hover over the expanded visualization. Buttons appear that allow you to download, zoom, pan, or autoscale the visualization.
Click Close to go back to the dashboard.
You can schedule the dashboard to automatically refresh at an interval.
At the top of the page, click Schedule.
If the dashboard already has a schedule, you see Scheduled instead of Schedule.
Select an interval, such as Every 1 hour.
You can click Advanced to create a more complex interval, such as every 5 years.
Select a SQL endpoint. A SQL endpoint is a compute resource that is specific to Databricks SQL. The SQL endpoint runs the dashboard’s queries and generates the visualizations when the dashboard is refreshed. Select Starter endpoint, which is created automatically on each workspace.
Admin users can create, configure, and delete SQL endpoints.
Optionally, subscribe workspace users or alert destinations to receive an email version of the dashboard when it is automatically refreshed.
Admin users can create, configure, and delete alert destinations. The email addresses of workspace users are automatically added as alert destinations.
The dashboard will be refreshed according to the schedule.
To stop automatically refreshing a dashboard:
- Click Scheduled.
- Set Refresh to Never.
- Click Save.
Now that you have explored the sample dashboards, you are almost ready to start working with your own data.
- An admin must complete the Perform the required admin onboarding tasks for Databricks SQL.
- Next, an admin can complete the Quickstart for admins: Set up a user to query a table.
- You can complete the Quickstart: Run and visualize a query, which depends upon the Quickstart for admins: Set up a user to query a table.