You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/docs/features/breaking-change-analysis.md
+11-7Lines changed: 11 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,23 +3,27 @@ title: Breaking Change Analysis
3
3
icon: octicons/diff-modified-24
4
4
---
5
5
6
-
**Breaking Change Analysis** examines modified models and categorizes changes into three types:**Breaking change**, **Partial breaking change**, and **Non breaking change**.
6
+
**Breaking Change Analysis** examines modified models and categorizes changes into three types:
7
7
8
-
Traditionally, any modification to a model’s SQL was assumed to affect all downstream models. However, not all changes have the same level of impact. For example, formatting adjustments or adding a new column should not break any downstream dependencies. **Breaking Change Analysis** helps you assess whether a change affects downstream models, and if so, to what extent.
8
+
- Breaking changes
9
+
- Partial breaking changes
10
+
- Non-breaking changes
9
11
12
+
It's generally assumed that any modification to a model’s SQL will affect all downstream models. However, not all changes have the same level of impact. For example, formatting adjustments or the addition of a new column should not break downstream dependencies. Breaking change analysis helps you assess whether a change affects downstream models and, if so, to what extent.
10
13
11
-
## Categories
14
+
15
+
## Categories of change
12
16
Category | Downstream Impact | Examples
13
17
---|---|---
14
-
Nonbreaking change | No downstream models are affected | Adding a new column, formatting SQL, adding comments
18
+
Non-breaking change | No downstream models are affected | New column, formatting SQL, adding comments
15
19
Partial breaking change | Only downstream models referencing certain columns are affected | Removing, renaming, or modifying the definition of a column
16
20
Breaking change | All downstream models are affected | Changing filter conditions (e.g. `WHERE`), sort order (`ORDER BY`), or other SQL logic
17
21
18
22
## Usage
19
23
20
-
To enable the feature, click the **Breaking Change Analysis** toggle on the **Lineage** page.
24
+
To enable **Breaking Change Analysis**, click the toggle on the **Lineage** page.
21
25
22
-
All modified models will display their change category directly on the node. Additionally, partial breaking changes are highlighted with a dashed orange border to indicate that they may not impact your downstream models.
26
+
All modified models display their change category directly on the node. Additionally, partial breaking changes are highlighted with a dashed orange border to indicate that they may not impact downstream models.
23
27
24
28
=== "Disabled"
25
29
@@ -32,7 +36,7 @@ All modified models will display their change category directly on the node. Add
32
36
33
37
## Column-Level Lineage
34
38
35
-
In models classified as **Non breaking** or **Partial breaking**, added, removed, or modified columns will be listed. You can click on a column to open its [Column-Level Lineage](./column-level-lineage.md)
39
+
In models classified as **non-breaking** or **partial breaking** - added, removed, or modified columns will be listed. Click on a column to open its [Column-Level Lineage](./column-level-lineage.md)
0 commit comments