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

Updates to dbt Explorer #4537

Merged
merged 16 commits into from
Nov 28, 2023
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
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
28 changes: 20 additions & 8 deletions website/docs/docs/collaborate/explore-projects.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,12 @@ To interact with the full lineage graph, you can:
- Hover over any item in the graph to display the resource’s name and type.
- Zoom in and out on the graph by mouse-scrolling.
- Grab and move the graph and the nodes.
- Right click on a node (context menu) to:
- Refocus on the node, including its parent and child nodes
- Refocus on the node and its children only
- Refocus on the node and it parents only
- Navigate to the [resource details](#view-resource-details) page

- Select a resource to highlight its relationship with other resources in your project. A panel opens on the graph’s right-hand side that displays a high-level summary of the resource’s details. The side panel includes a **General** tab for information like description, materialized type, and other details.
- Click the Share icon in the side panel to copy the graph’s link to your clipboard.
- Click the View Resource icon in the side panel to [view the resource details](#view-resource-details).
Expand All @@ -63,7 +69,7 @@ To interact with the full lineage graph, you can:
- [View resource details](#view-resource-details) by selecting a node (double-clicking) in the graph.
- Click the List view icon in the graph's upper right corner to return to the main **Explore** page.

<LoomVideo id='1c2224ee7d6e4bbca850345e9a7b79aa' />
<LoomVideo id='4f85654b5cc443478299d2bb1e9211f6?t=0' />


## Search for resources {#search-resources}
Expand All @@ -74,6 +80,10 @@ Select a node (single-click) in the lineage graph to highlight its relationship
### Search with keywords
When searching with keywords, dbt Explorer searches through your resource metadata (such as resource type, resource name, column name, source name, tags, schema, database, version, alias/identifier, and package name) and returns any matches.

With keyword search, Explorer provides a side panel (to the right of the main section) where you can filter your search results further by resource type. You can filter by resource tags for all resources or model access levels within the **Models** option. As an example, when searching for “sale”, the results will include all resources with the keyword “sale” in their metadata; and, you can choose **Model** and **Source** in the side panel to filter those results further to only display models or sources with the keyword match.

For a search on an exact column name, the results will include all relational nodes with that specific column in their schemas. If there is a match, the search result will include a notice indicating that the resource contains the specified column.
mirnawong1 marked this conversation as resolved.
Show resolved Hide resolved

### Search with selector methods

You can search with [selector methods](/reference/node-selection/methods). Below are the selectors currently available in dbt Explorer:
Expand All @@ -91,9 +101,11 @@ You can search with [selector methods](/reference/node-selection/methods). Below

</VersionBlock>

### Search with graph operators
Because the results of selectors are immutable, the side panel to filter results further is not be available in this view.

When searching with selector methods, you can also use [graph operators](/reference/node-selection/graph-operators). For example, `+orders` returns all the parents of `orders`. This functionality is not available for keyword search.

You can use [graph operators](/reference/node-selection/graph-operators) on keywords or selector methods. For example, `+orders` returns all the parents of `orders`.
These search methods are also available in the [project full lineage graph](#project-lineage). Searching these methods will filter the DAG shown on screen to narrow your focus on the resources of interest.

### Search with set operators

Expand All @@ -107,7 +119,7 @@ You can use keyword search to highlight results that are filtered by the selecto

When searching in this way, the selectors behave as filters that you can use to narrow the search and keywords as a way to find matches within those filtered results.

<LoomVideo id='7ff433c392dd48d68311e17ce2adc57f' />
<LoomVideo id='712c8b74a6e242699ad2d32e2b0693a5' />

## Browse with the sidebar

Expand All @@ -120,7 +132,7 @@ To browse using a different view, you can choose one of these options from the *
- **File Tree** &mdash; All resources in the project organized by the file in which they are defined. This mirrors the file tree in your dbt project repository.
- **Database** &mdash; All resources in the project organized by the database and schema in which they are built. This mirrors your data platform's structure that represents the [applied state](/docs/dbt-cloud-apis/project-state) of your project.

<LoomVideo id='5d4a4b7904184b76bc907edad1555163' />
<LoomVideo id='3bd3b16b22ab49ea809c9a863be06d05' />

## View model versions

Expand All @@ -132,7 +144,7 @@ You can view the definition and latest run results of any resource in your proje
The details (metadata) available to you depends on the resource’s type, its definition, and the [commands](/docs/deploy/job-commands) that run within jobs in the production environment.


<LoomVideo id='2b2ae3e376fa46e4b344eb5becfd730e' />
<LoomVideo id='cefbb113427e45fd8106607476ec0676' />

### Example of model details

Expand All @@ -143,11 +155,11 @@ An example of the details you might get for a model:
- **Lineage** graph &mdash; The model’s lineage graph that you can interact with. The graph includes one parent node and one child node from the model. Click the Expand icon in the graph's upper right corner to view the model in full lineage graph mode.
- **Description** section &mdash; A [description of the model](/docs/collaborate/documentation#adding-descriptions-to-your-project).
- **Recent** section &mdash; Information on the last time the model ran, how long it ran for, whether the run was successful, the job ID, and the run ID.
- **Tests** section &mdash; [Tests](/docs/build/tests) for the model.
- **Tests** section &mdash; [Tests](/docs/build/tests) for the model, including a status indicator for the latest test status. A :white_check_mark: denotes a passing test.
- **Details** section &mdash; Key properties like the model’s relation name (for example, how it’s represented and how you can query it in the data platform: `database.schema.identifier`); model governance attributes like access, group, and if contracted; and more.
- **Relationships** section &mdash; The nodes the model **Depends On**, is **Referenced by**, and (if applicable) is **Used by** for projects that have declared the models' project as a dependency.
- **Code** tab &mdash; The source code and compiled code for the model.
- **Columns** tab &mdash; The available columns in the model. This tab also shows tests results (if any) that you can select to view the test's details page. A :white_check_mark: denotes a passing test.
- **Columns** tab &mdash; The available columns in the model. This tab also shows tests results (if any) that you can select to view the test's details page. A :white_check_mark: denotes a passing test. To filter the columns in the resource, you can use the search bar that's located at the top of the columns view.


### Example of exposure details
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
---
title: "Enhancement: New features and UI changes to dbt Explorer"
description: "November 2023: New features and UI changes to dbt Explorer"
mirnawong1 marked this conversation as resolved.
Show resolved Hide resolved
sidebar_label: "Enhancement: New features and UI changes to dbt Explorer"
sidebar_position: 08
tags: [Nov-2023]
---
Copy link
Contributor

Choose a reason for hiding this comment

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

i think the date property was missed! might be good to post in the dbt cloud community channel

Copy link
Contributor Author

Choose a reason for hiding this comment

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

great flag! will update in a fast-follow pr, tysm!


dbt Labs is excited to announce the latest features and UI updates to dbt Explorer!

For more details, refer to [Explore your dbt projects](/docs/collaborate/explore-projects).

## The project's lineage graph

- The search bar in the full lineage graph is now to the right of the graph and is larger.
nghi-ly marked this conversation as resolved.
Show resolved Hide resolved
- The project/account navigation breadcrumbs has been updated.
nghi-ly marked this conversation as resolved.
Show resolved Hide resolved
- A context menu is now available so you can explore a node's lineage and its details more easily from the full lineage graph.
nghi-ly marked this conversation as resolved.
Show resolved Hide resolved

<LoomVideo id='1d28cc6443a94f00bbcb43d6ab3ad0d9' />

## Search improvements

- When searching with keywords, a new side panel UI to filter search results by resource type.
nghi-ly marked this conversation as resolved.
Show resolved Hide resolved
- Improved search for only exact column names.
nghi-ly marked this conversation as resolved.
Show resolved Hide resolved

<LoomVideo id='5c4dc30afa824897a8c8b3ed37cee782?t=14' />

## Browse with sidebar
nghi-ly marked this conversation as resolved.
Show resolved Hide resolved
nghi-ly marked this conversation as resolved.
Show resolved Hide resolved
- There are UI updates to browsing your resources with the sidebar.

<LoomVideo id='eb7aad34b581483fb340ab7ef9aac2e0' />

## Resource details
- In the resource details for models, there are UI updates to the **Tests** section and the **Columns** tab.
nghi-ly marked this conversation as resolved.
Show resolved Hide resolved

<LoomVideo id='04f3e35cdc0c41109e91f7692d432059' />
Loading