From 2c87da19fb337243602fa8fed31e0b319bb385c4 Mon Sep 17 00:00:00 2001 From: Cameron Afzal Date: Thu, 15 Feb 2024 13:03:15 -0800 Subject: [PATCH 1/4] Clarify search in Explorer Clarifying the search methods available and how they work, given updates to the product. --- .../docs/docs/collaborate/explore-projects.md | 18 +++++------------- 1 file changed, 5 insertions(+), 13 deletions(-) diff --git a/website/docs/docs/collaborate/explore-projects.md b/website/docs/docs/collaborate/explore-projects.md index ed5dee93317..ddceaec4dc5 100644 --- a/website/docs/docs/collaborate/explore-projects.md +++ b/website/docs/docs/collaborate/explore-projects.md @@ -75,22 +75,16 @@ To interact with the full lineage graph, you can: ## Search for resources {#search-resources} -With the search bar (on the upper left corner of the page or in a lineage graph), you can search with keywords or by using [node selection syntax](/reference/node-selection/syntax). The resources that match your search criteria will display as a lineage graph and a table in the main section of the page. - -Select a node (single-click) in the lineage graph to highlight its relationship with your other search results and to display which project contains the resource's definition. When you choose a node (double-click) in the lineage graph or when you select a resource in the table, dbt Explorer displays the [resource's details page](#view-resource-details). +With the search bar (on the upper left corner of the page or in a lineage graph), you can search with keywords or selectors. The resources that match your search criteria will display in a list (keyword search) or the lineage graph (selector search). ### 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. - -- Keyword search features a side panel (to the right of the main section) to filter search results by resource type. -- Use this panel to select specific resource tags or model access levels under the **Models** option. - - For example, a search for "sale" returns results that include all resources with the keyword "sale" in their metadata. Filtering by **Models** and **Sources** refines these results to only include models or sources. +When searching with keywords, dbt Explorer searches through your resource metadata, such as resource name, and returns any matches. When searching for an exact column name, the results show all relational nodes containing that column in their schemas. If there's a match, a notice in the search result indicates the resource contains the specified column. -- When searching for an exact column name, the results show all relational nodes containing that column in their schemas. If there's a match, a notice in the search result indicates the resource contains the specified column. +You can then refine the search results using the filters in the panel on the right side of the page. Use this panel to select specific resource types or tags to apply. You can filter on model properties (access or materialization type) under the **Models** option. ### Search with selectors -You can search with [selectors](/reference/node-selection/methods). Below are the selectors currently available in dbt Explorer: +You can also search with [selectors](/reference/node-selection/methods) within the full-screen lineage graph using the input bar in the upper-right hand corner. Below are the selectors currently available in dbt Explorer: - `fqn:` — Find resources by [file or fully qualified name](/reference/node-selection/methods#the-fqn-method). This selector is the search bar's default. If you want to use the default, it's unnecessary to add `fqn:` before the search term. - `source:` — Find resources by a specified [source](/reference/node-selection/methods#the-source-method). @@ -105,9 +99,7 @@ You can search with [selectors](/reference/node-selection/methods). Below are th -Because the results of selectors are immutable, the filter side panel is not available with this search method. - -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. +When searching with selector methods, you can also use [graph operators](/reference/node-selection/graph-operators). For example, `+orders` returns all of the nodes upstream of `orders` and `orders+1` returns just the nodes immediately downstream (the children) of `orders`. You can use multiple selector methods in your search query with [set operators](/reference/node-selection/set-operators). A space implies a union set operator and a comma for an intersection. For example: - `resource_type:metric,tag:nightly` — Returns metrics with the tag `nightly` From bd7d453333b57e45f276fa033ebe3c73dc3c2ab7 Mon Sep 17 00:00:00 2001 From: Ly Nguyen <107218380+nghi-ly@users.noreply.github.com> Date: Thu, 15 Feb 2024 15:12:21 -0800 Subject: [PATCH 2/4] Update website/docs/docs/collaborate/explore-projects.md --- website/docs/docs/collaborate/explore-projects.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/docs/collaborate/explore-projects.md b/website/docs/docs/collaborate/explore-projects.md index ddceaec4dc5..e43224f0001 100644 --- a/website/docs/docs/collaborate/explore-projects.md +++ b/website/docs/docs/collaborate/explore-projects.md @@ -99,7 +99,7 @@ You can also search with [selectors](/reference/node-selection/methods) within t -When searching with selector methods, you can also use [graph operators](/reference/node-selection/graph-operators). For example, `+orders` returns all of the nodes upstream of `orders` and `orders+1` returns just the nodes immediately downstream (the children) of `orders`. +When searching with selector methods, you can also use [graph operators](/reference/node-selection/graph-operators). For example, `+orders` returns all the upstream nodes of `orders` and `orders+1` returns just the nodes immediately downstream (the children) of `orders`. You can use multiple selector methods in your search query with [set operators](/reference/node-selection/set-operators). A space implies a union set operator and a comma for an intersection. For example: - `resource_type:metric,tag:nightly` — Returns metrics with the tag `nightly` From 52cb76c95939479d8a24f42a06db5987575976f4 Mon Sep 17 00:00:00 2001 From: Ly Nguyen <107218380+nghi-ly@users.noreply.github.com> Date: Thu, 15 Feb 2024 15:17:35 -0800 Subject: [PATCH 3/4] Update website/docs/docs/collaborate/explore-projects.md --- website/docs/docs/collaborate/explore-projects.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/docs/collaborate/explore-projects.md b/website/docs/docs/collaborate/explore-projects.md index e43224f0001..603467952bc 100644 --- a/website/docs/docs/collaborate/explore-projects.md +++ b/website/docs/docs/collaborate/explore-projects.md @@ -80,7 +80,7 @@ With the search bar (on the upper left corner of the page or in a lineage graph) ### Search with keywords When searching with keywords, dbt Explorer searches through your resource metadata, such as resource name, and returns any matches. When searching for an exact column name, the results show all relational nodes containing that column in their schemas. If there's a match, a notice in the search result indicates the resource contains the specified column. -You can then refine the search results using the filters in the panel on the right side of the page. Use this panel to select specific resource types or tags to apply. You can filter on model properties (access or materialization type) under the **Models** option. +You can then refine the search results using the filters in the panel on the right-hand side of the page. Use this panel to select specific resource types or tags to apply. You can filter on model properties (access or materialization type) under the **Models** option. ### Search with selectors From 9a4301ab242998a0c5d12ad6d6398e0c0a1d027f Mon Sep 17 00:00:00 2001 From: Ly Nguyen <107218380+nghi-ly@users.noreply.github.com> Date: Thu, 15 Feb 2024 15:33:46 -0800 Subject: [PATCH 4/4] Update website/docs/docs/collaborate/explore-projects.md --- website/docs/docs/collaborate/explore-projects.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/docs/collaborate/explore-projects.md b/website/docs/docs/collaborate/explore-projects.md index 603467952bc..8d76b0cb563 100644 --- a/website/docs/docs/collaborate/explore-projects.md +++ b/website/docs/docs/collaborate/explore-projects.md @@ -84,7 +84,7 @@ You can then refine the search results using the filters in the panel on the rig ### Search with selectors -You can also search with [selectors](/reference/node-selection/methods) within the full-screen lineage graph using the input bar in the upper-right hand corner. Below are the selectors currently available in dbt Explorer: +You can search with [selectors](/reference/node-selection/methods) within the full lineage graph using the search bar. Below are the selectors currently available in dbt Explorer: - `fqn:` — Find resources by [file or fully qualified name](/reference/node-selection/methods#the-fqn-method). This selector is the search bar's default. If you want to use the default, it's unnecessary to add `fqn:` before the search term. - `source:` — Find resources by a specified [source](/reference/node-selection/methods#the-source-method).