-
Notifications
You must be signed in to change notification settings - Fork 1
Add impact radius doc #24
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
Merged
popcornylu
merged 4 commits into
main
from
feature/drc-1370-update-the-doc-for-impact-radius
Jul 8, 2025
Merged
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,82 @@ | ||
--- | ||
title: Impact Radius | ||
icon: material/adjust | ||
--- | ||
|
||
**Impact Radius** helps you analyze changes and identify downstream impacts at the column level. | ||
|
||
While dbt provides a similar capability using the [state selector](https://docs.getdbt.com/reference/node-selection/methods#state) with `state:modified+` to identify modified nodes and their downstream dependencies, Recce goes further. By analyzing SQL code directly, Recce enables **fine-grained impact radius analysis**. It reveals how changes to specific columns can ripple through your data pipeline, helping you prioritize which models—and even which columns—deserve closer attention. | ||
|
||
|
||
=== "state:modified+" | ||
|
||
{: .shadow} | ||
|
||
=== "Impact Radius" | ||
|
||
{: .shadow} | ||
|
||
|
||
|
||
## Usage | ||
|
||
### Show impact radius | ||
|
||
1. Click the **Impact Radius** button in the upper-left corner. | ||
|
||
{: .shadow} | ||
|
||
1. The impact radius will be displayed. | ||
|
||
{: .shadow} | ||
|
||
1. To exit impact radius view, click the close button in the upper-left corner. | ||
|
||
{: .shadow} | ||
|
||
### Show impact radius for a single changed model | ||
|
||
1. Hover over a changed model, then click the **target icon** or right-click the model and click the **Show Impact Radius** | ||
|
||
{: .shadow} | ||
|
||
1. The impact radius for this model will be displayed. | ||
|
||
{: .shadow} | ||
|
||
1. To exit impact radius view, click the close button in the upper-left corner. | ||
|
||
{: .shadow} | ||
|
||
|
||
## How it works | ||
|
||
Two core features power the impact radius analysis: | ||
|
||
**[Breaking Change Analysis](./breaking-change-analysis.md)** classifies modified models into three categories: | ||
|
||
- **Breaking changes**: Impact all downstream **models** | ||
- **Non-breaking changes**: Do not impact any downstream **models** | ||
- **Partial breaking changes**: Impact only downstream **models or columns** that depend on the modified columns | ||
|
||
**[Column-level lineage](./column-level-lineage.md)** analyzes your model's SQL to identify column-level dependencies: | ||
|
||
- Which upstream **columns** are used as filters or grouping keys. If those upstream **columns** change, the current **model** is impacted. | ||
- Which upstream **columns** a specific column references. If those upstream **columns** change, the specific **column** is impacted. | ||
|
||
## Putting It Together | ||
|
||
With the insights from the two features above, Recce determines the impact radius: | ||
|
||
1. If a model has a **breaking change**, include all downstream models in the impact radius. | ||
1. If a model has a **non-breaking change**, include only the downstream columns and models of newly added columns. | ||
1. If a model has a **partial breaking change**, include the downstream columns and models of added, removed, or modified columns. | ||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.