Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Explorer workshop guide #6150

Merged
merged 52 commits into from
Oct 3, 2024
Merged
Show file tree
Hide file tree
Changes from 21 commits
Commits
Show all changes
52 commits
Select commit Hold shift + click to select a range
451dc85
Create explorer-qs.md
MichelleBaird-DBT Sep 24, 2024
653a920
Update explorer-qs.md
MichelleBaird-DBT Sep 24, 2024
a40c9df
Update explorer-qs.md
MichelleBaird-DBT Sep 25, 2024
8c2f62c
Add files via upload
MichelleBaird-DBT Sep 25, 2024
0da2ebb
Add files via upload
MichelleBaird-DBT Sep 25, 2024
c593c59
Add files via upload
MichelleBaird-DBT Sep 25, 2024
389b1b0
Add files via upload
MichelleBaird-DBT Sep 25, 2024
bb4b374
Update explorer-qs.md
MichelleBaird-DBT Sep 25, 2024
510fce4
Update explorer-qs.md
MichelleBaird-DBT Sep 25, 2024
d0ba5ed
Merge branch 'current' into explorer-workshop-guide
mirnawong1 Sep 26, 2024
a3a4b97
Update website/docs/guides/explorer-qs.md
mirnawong1 Sep 26, 2024
63eb0be
Merge branch 'current' into explorer-workshop-guide
mirnawong1 Sep 26, 2024
5f86552
Update website/docs/guides/explorer-qs.md
mirnawong1 Sep 26, 2024
dda8d8a
Update website/docs/guides/explorer-qs.md
mirnawong1 Sep 26, 2024
7a1942e
update first page
mirnawong1 Sep 26, 2024
23b43cf
tweaks
mirnawong1 Sep 26, 2024
0130780
add id
mirnawong1 Sep 26, 2024
c0d90da
add next steps
mirnawong1 Sep 26, 2024
9b91c15
Update explorer-qs.md
MichelleBaird-DBT Sep 26, 2024
81ac1f0
Update explorer-qs.md
MichelleBaird-DBT Sep 26, 2024
f412ee1
Merge branch 'current' into explorer-workshop-guide
mirnawong1 Sep 26, 2024
48d429d
Merge branch 'current' into explorer-workshop-guide
mirnawong1 Sep 27, 2024
41ff8ae
Update website/docs/guides/explorer-qs.md
mirnawong1 Sep 27, 2024
36a177d
Update website/docs/guides/explorer-qs.md
mirnawong1 Sep 27, 2024
6e7b9ba
Update website/docs/guides/explorer-qs.md
mirnawong1 Sep 27, 2024
f689960
Update website/docs/guides/explorer-qs.md
mirnawong1 Sep 27, 2024
7d70135
Update website/docs/guides/explorer-qs.md
mirnawong1 Sep 27, 2024
543f42a
Update website/docs/guides/explorer-qs.md
mirnawong1 Sep 27, 2024
aa9091d
Update explorer-qs.md
mirnawong1 Sep 27, 2024
ce7a3ce
Update explorer-qs.md
MichelleBaird-DBT Oct 1, 2024
6f40304
Update explorer-qs.md
MichelleBaird-DBT Oct 1, 2024
bbab137
Add files via upload
MichelleBaird-DBT Oct 1, 2024
f35127b
Add files via upload
MichelleBaird-DBT Oct 1, 2024
ebe612a
Update explorer-qs.md
MichelleBaird-DBT Oct 1, 2024
622bfe0
Add files via upload
MichelleBaird-DBT Oct 1, 2024
45e17a8
Update explorer-qs.md
MichelleBaird-DBT Oct 1, 2024
1e0a01a
Merge branch 'current' into explorer-workshop-guide
MichelleBaird-DBT Oct 1, 2024
8f229e1
Update explorer-qs.md
MichelleBaird-DBT Oct 1, 2024
34126f1
Merge branch 'current' into explorer-workshop-guide
mirnawong1 Oct 2, 2024
6eb3f6a
Merge branch 'current' into explorer-workshop-guide
mirnawong1 Oct 2, 2024
6f286fe
Update explorer-qs.md
mirnawong1 Oct 2, 2024
19a5930
Merge branch 'current' into explorer-workshop-guide
mirnawong1 Oct 2, 2024
ec04d8f
Merge branch 'current' into explorer-workshop-guide
mirnawong1 Oct 2, 2024
62e65ef
Merge branch 'current' into explorer-workshop-guide
mirnawong1 Oct 2, 2024
a735bae
coap tweaks in final review
coapacetic Oct 2, 2024
8b39688
Merge branch 'current' into explorer-workshop-guide
coapacetic Oct 2, 2024
39a9535
tweak image and some copy
coapacetic Oct 2, 2024
215c250
Merge branch 'explorer-workshop-guide' of github.com:dbt-labs/docs.ge…
coapacetic Oct 2, 2024
8dcdfde
Merge branch 'current' into explorer-workshop-guide
MichelleBaird-DBT Oct 2, 2024
f7102f5
Merge branch 'current' into explorer-workshop-guide
mirnawong1 Oct 3, 2024
5505855
Update explorer-qs.md
mirnawong1 Oct 3, 2024
b4eb461
Merge branch 'current' into explorer-workshop-guide
mirnawong1 Oct 3, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
137 changes: 137 additions & 0 deletions website/docs/guides/explorer-qs.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,137 @@
---
title: "Quickstart for the dbt Explorer workshop"
id: "explorer-quickstart"
description: "Use this guide to build and define metrics, set up the dbt Cloud Semantic Layer, and query them using Google Sheets."
sidebar_label: "Quickstart dbt Explorer"
icon: 'guides'
hide_table_of_contents: true
tags: ['Explorer', 'Snowflake', 'dbt Cloud','Quickstart']
keywords: ['dbt Explorer','Mesh','dbt Cloud', 'Snowflake', 'Multi-Project']
level: 'Beginner'
recently_updated: true
---

## Introduction

Unlock the power of [dbt Explorer](/docs/collaborate/explore-projects) in this hands-on workshop designed for analytics engineers, data analysts, stakeholders, and data leaders.

This quickstart guide accompanies the Explorer hands-on workshop and help you dive into a production-level dbt Mesh implementation and discover how to explore your data workflows.⁠ Whether you're looking to streamline your data operations, improve data quality, or self-serve information about your data platform, this workshop will equip you with the tools and knowledge to take your dbt projects to the next level.

By the end of the guide and workshop, you'll understand how to leverage dbt Explorer and have the confidence to navigate multiple dbt projects, trace dependencies, and identify opportunities to improve performance and data quality.

### What you'll learn
In this guide, you will learn how to:
- Navigate multiple dbt projects using dbt Explorer
- Self-serve on data documentation
- Trace dependencies at the model and column level
- Identify opportunities to improve performance and data quality

### Prerequisites
- Familiarity with data platforms

## Setup
Now we’ll be creating your dbt Cloud account and connecting it to a data warehouse.
- Go to this URL: https://cloud.getdbt.com/coalesce-workshop-signup
- Sign out if you're already logged in.
- Enter your first name and last name.
- Select the **Exploring a dbt Mesh implementation with dbt Explorer** option.
- Use the password provided by the workshop facilitator.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we use passcode since that is the verbiage for the signup page?

mirnawong1 marked this conversation as resolved.
Show resolved Hide resolved
- Agree to the terms of service and click the **Complete Registration** button.
- Wait about 30 seconds, you’ll be in the dbt Cloud project for this course and already connected to a data warehouse.

## Project overview and latest run status

<Lightbox src="/img/quickstarts/dbt-cloud/explorer_performance_tab.png" width="100%" title="dbt Explorer performance tab" />

With dbt Explorer, you can view your project's resources (such as models, tests, and metrics), their lineage, and model consumption to gain a better understanding of its latest production state. Navigate and manage your projects within dbt Cloud to help you and other data developers, analysts, and consumers discover and leverage your dbt resources.

### Hands-On
- Explore the **Model** tab
- Which job took the Longest?
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

how do you feel about 'Try it out' so it's more clear that this is an interactive part?

- Which job/jobs failed? Why?

- Explore the **Sources** tab
- What sources can we see?

- Explore the **Tests** Tab
- Did we run the right test?, Which test were missing? Why?
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Extra comma here

mirnawong1 marked this conversation as resolved.
Show resolved Hide resolved

- Explore **Exposures**
- Check Quality and where they came from

## Lineage

dbt Explorer provides a visualization of your project’s <Term id="dag"/> that you can interact with. The nodes in the lineage graph represent the project’s resources and the edges represent the relationships between the nodes. Nodes are color-coded and include iconography according to their resource type.

- Use the search bar and [node selectors](/reference/node-selection/syntax) to filter your DAG.
- [Lenses](/docs/collaborate/explore-projects#lenses) make it easier to understand your project’s contextual metadata at scales, especially to distinguish a particular model or a subset of models.
- Applying a lens adds tags to the nodes, showing metadata like layer values, with color coding to help you distinguish them.

<Lightbox src="/img/quickstarts/dbt-cloud/dbt_explorer_dag.png" width="100%" title="dbt Explorer's lineage graph" />

- Use the [advanced search](/docs/collaborate/explore-projects#search-resources) feature to locate resources in your project. Perform hard searches and keyword searches. All resource names, column names, resources descriptions, warehouse relations, and code matching your search criteria will appear in the center of the page. Apply filters to fully refine your search
- When searching for a column name, the results show all relational nodes containing that column in their schemas.

<Lightbox src="/img/quickstarts/dbt-cloud/dbt_explorer_advanced_search.png" width="100%" title="dbt Explorer's advanced search feature" />

### Hands-On
1. On the left hand side, click on the company and ensure you're in the **Overview Project details** section → Next to **Overview** → Select **View Lineage**.

2. Select a mart model and select everything downstream.
- Which models depend on models from another project?
- Click on the other project's lineage.

3. Explore lenses and find table materializations in your current project.
- Which are the biggest view clusters?

4. Experiment with different lenses, such as **Model layer**, **Test status**, **Resource type**, and so on.

5. Drill down on a node and explore the **Column Lineage** and its evolution.
- Expand each column's full lineage.

## Multi-project
Use dbt Explorer to gain a deeper understanding of *all* of you dbt Cloud projects with its [multi-project capabilities](/docs/collaborate/explore-multiple-projects).
- See the number of public, protected, and private models, as well as metrics for each project.
- View cross-project lineage and navigate between individual projects’ lineage graphs.
- Explore column-level lineage across projects.

### Hands-On
- Identify which models in the project are public and being referenced by another project.
- Switch between the lineage graphs of two different projects and explore the available assets.
- What sources are visible?
- Use the multi-project column-level lineage to locate a column that exists in models across multiple projects.

## Project recommendations
Project recommendations suggests project improvements and provides insight into how you can create a better-documented, better-tested, and better-built dbt project.

These recommendations are designed to build trust in your project and reduce confusion.

To learn more about the specific suggestions and the reasons behind them, check out the [Project recommendations page](/docs/collaborate/project-recommendations).

<Lightbox src="/img/quickstarts/dbt-cloud/dbt_explorer_project_recs.png" width="80%" title="dbt Explorer's project recommendation tab" />

### Hands-On
- Review your project recommendations and choose one improvement to implement (such as adding a description to a primary key that’s missing one).
MichelleBaird-DBT marked this conversation as resolved.
Show resolved Hide resolved

## What's next
mirnawong1 marked this conversation as resolved.
Show resolved Hide resolved

<ConfettiTrigger>

Congratulations! You've completed the dbt Explorer workshop. You now have the tools and knowledge to navigate multiple dbt projects, trace dependencies, and identify opportunities to improve performance and data quality.

You've learned how to:
- Use dbt Explorer to visualize your project’s lineage and interact with the DAG
- Search for resources in your project and apply filters to refine your search
- Explore lenses and find table materializations in your current project
- Navigate multiple dbt projects using dbt Explorer
- Trace dependencies at the model and column level
- Review project recommendations and implement improvements

For the next steps, you can check out the [dbt Explorer documentation](/docs/collaborate/explore-projects) and [FAQs](/docs/collaborate/dbt-explorer-faqs) to learn more about how to use dbt Explorer.

Keep an eye out for new features coming out soon, like:
- More auto exposure integrations (like PowerBI)
mirnawong1 marked this conversation as resolved.
Show resolved Hide resolved
- Model query history for additional warehouses (like Redshift and DataBricks)
mirnawong1 marked this conversation as resolved.
Show resolved Hide resolved
- Improvements to data health tiles
mirnawong1 marked this conversation as resolved.
Show resolved Hide resolved

</ConfettiTrigger>
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading