Skip to content

Commit f08f875

Browse files
authored
Merge pull request #160 from DataRecce/feature/drc-1097-cll-doc-site
Add the column-level lineage content
2 parents 0f32f15 + d7cd906 commit f08f875

File tree

5 files changed

+40
-1
lines changed

5 files changed

+40
-1
lines changed

docs/assets/images/features/cll-1.png

131 KB
Loading

docs/assets/images/features/cll-2.png

155 KB
Loading

docs/docs/features/breaking-change-analysis.md

-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22
title: Breaking Change Analysis
33
icon: octicons/diff-modified-24
44
---
5-
`Experimental Feature`
65

76
Breaking change analysis examines models for modifications to the SQL semantic tree that could potentially alter the data generated by the model, resulting in downstream impact.
87

+39
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
---
2+
title: Column-Level Lineage
3+
icon: material/file-tree
4+
---
5+
6+
Column-Level Lineage provides visibility into the upstream and downstream relationships of a column.
7+
8+
Common use-cases for column-level lineage are
9+
10+
1. **Source Exploration**: During development, column-level lineage helps you understand how a column is derived.
11+
2. **Impact Analysis**: When modifying the logic of a column, column-level lineage enables you to assess the potential impact across the entire DAG.
12+
3. **Root Cause Analysis**: Column-level lineage helps identify the possible source of errors by tracing data lineage at the column level.
13+
14+
## Usage
15+
16+
1. Select a node in the lineage DAG, then click the **eye** icon next to the column you want to view.
17+
18+
![alt text](../../assets/images/features/cll-1.png){: .shadow}
19+
20+
1. The column-level lineage for the selected column will be displayed.
21+
22+
![alt text](../../assets/images/features/cll-2.png){: .shadow}
23+
24+
## Transformation Types
25+
26+
The transformation type is also displayed for each column, which will help you understand how the column was generated or modified.
27+
28+
| Type | Description |
29+
|------|--------------|
30+
| Pass-through |The column is directly selected from the upstream table. |
31+
| Renamed | The column is selected from the upstream table but with a different name. |
32+
| Derived | The column is created through transformations applied to upstream columns, such as calculations, conditions, functions, or aggregations. |
33+
| Source | The column is not derived from any upstream data. It may originate from a seed/source node, literal value, or data generation function. |
34+
| Unknown | We have no information about the transformation type. This could be due to a parse error, or other unknown reason. |
35+
36+
37+
## Limitation
38+
39+
Column-level lineage only displays column selection operations. It does not indicate if a column has been used in filters (WHERE clauses), with grouping (GROUP BY), joins, or other transformations.

mkdocs.yml

+1
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,7 @@ nav:
5555
- docs/features/preset-checks.md
5656
- docs/features/node-selection.md
5757
- docs/features/breaking-change-analysis.md
58+
- docs/features/column-level-lineage.md
5859
- docs/reference/configuration.md
5960
- Scenarios:
6061
- docs/guides/scenario-dev.md

0 commit comments

Comments
 (0)