diff --git a/docs/_sidebar.md b/docs/_sidebar.md index bcba6da..2b656a9 100644 --- a/docs/_sidebar.md +++ b/docs/_sidebar.md @@ -11,6 +11,7 @@ - [Snowflake Extension](/getting-started/developer/snowflake-extension.md) - [Transform Tab](/getting-started/developer/transform-tab.md) - [Working with dbt in Datacoves](/getting-started/developer/working-with-dbt-datacoves.md) + - [Lineage View](/getting-started/developer/lineage-view.md) - [Using Git](/getting-started/developer/using-git.md) - **Diving Deeper** - [How to](/how-tos/) diff --git a/docs/getting-started/developer/assets/lineage_view_with_model.png b/docs/getting-started/developer/assets/lineage_view_with_model.png new file mode 100644 index 0000000..ebde1d5 Binary files /dev/null and b/docs/getting-started/developer/assets/lineage_view_with_model.png differ diff --git a/docs/getting-started/developer/lineage-view.md b/docs/getting-started/developer/lineage-view.md new file mode 100644 index 0000000..046f9f0 --- /dev/null +++ b/docs/getting-started/developer/lineage-view.md @@ -0,0 +1,40 @@ +# Lineage View + +The **Lineage View** panel is a feature of the Datacoves VSCode extension that provides a visual representation of the lineage of your project. This tool helps you quickly understand how data flows between models, sources, and downstream dependencies within your dbt project. + +## What is the Lineage View? + +The Lineage View displays a graph of your dbt model's relationships, showing both upstream and downstream dependencies. This visualization makes it easy to: + +- See which sources and models feed into your current model +- Identify all models and reports that depend on your current model +- Understand the impact of changes to a model across your project + +## Usage + +The basic usage of Lineage View consists of the following steps: + +1. **Open a dbt model or yml file** in your VSCode workspace. +2. Locate the **Lineage View** panel, typically found in the lower panel (alongside Terminal, Output, Datacoves) +3. The panel will automatically display the lineage graph for the currently sql or yml file. + +### Additional features + +In addition to seeing your model(s) lineage, you can also: + +- **Single-click** on a node to open the SQL file. +- **Double-click** on a node to open the YML file. +- **Right click** a node and perform a dbt action(run, test, compile, open files, etc) + +You can also look up other dbt models and change the parent and child nodes displayed using one of the following: + - `{n}+my_model` + - `my_model+{n}` + - `{n}+my_model+{n}` + +![Lineage View Example](assets/lineage_view_with_model.png) + +## Configuration + +Lineage Panel has 3 configurable settings. As with any VSCode setting, these can be [overridden](/how-tos/vscode/override) in the `settings.json` file located in `workspace/.vscode/settings.json`: + +- Default Expansion (`dbt.lineage.defaultExpansion`: number): How many nodes should expand by default for the currently-opened model. diff --git a/docs/getting-started/developer/working-with-dbt-datacoves.md b/docs/getting-started/developer/working-with-dbt-datacoves.md index aaf6f4b..3d0c809 100644 --- a/docs/getting-started/developer/working-with-dbt-datacoves.md +++ b/docs/getting-started/developer/working-with-dbt-datacoves.md @@ -18,6 +18,10 @@ This guide covers various aspects of using Datacoves for creating, editing, runn - **Run current button:** Understand how to use the "Run current" button to execute models. +## dbt Model Lineage + +- **Datacoves Linage Panel** Learn how to use the [Datacoves Linage Panel](/getting-started/developer/lineage-view.md) to see the lineage of dbt exposures, models, and sources. + ## Opening a Model and Auto Complete - **Quick model access using Cmd/Ctrl + P:** Learn how to quickly access models using the keyboard shortcut.