feat: added lineage item and lineage entities #90
There are no files selected for viewing
This file contains 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,37 @@ | ||
| # Copyright Contributors to the Amundsen project. | ||
| # SPDX-License-Identifier: Apache-2.0 | ||
|
|
||
| from typing import Optional, List | ||
|
|
||
| from amundsen_common.models.table import Badge | ||
|
|
||
| import attr | ||
| from marshmallow_annotations.ext.attrs import AttrsSchema | ||
|
|
||
|
|
||
| @attr.s(auto_attribs=True, kw_only=True) | ||
| class LineageItem: | ||
| key: str # down/upstream table/col/task key | ||
| level: int # upstream/downstream distance from current resource | ||
| source: str # database this resource is from | ||
| badges: Optional[List[Badge]] = None | ||
| usage: Optional[int] = None # statistic to sort lineage items by | ||
|
|
||
|
|
||
| class LineageItemSchema(AttrsSchema): | ||
| target = LineageItem | ||
| register_as_scheme = True | ||
|
|
||
|
|
||
| @attr.s(auto_attribs=True, kw_only=True) | ||
| class Lineage: | ||
| key: str # current table/col/task key | ||
| direction: str # upstream/downstream/both | ||
|
There was a problem hiding this comment. any reason we need direction and depth if we have There was a problem hiding this comment. LineageItem seems to include level already? There was a problem hiding this comment. Just to persist the selection (upstream, downstream, both) send over in the request. Similarly depth might be needed because it tells you how many levels were requested for this response. |
||
| depth: int # how many levels up/down 0 == all | ||
| lineage_entities_upstream: List[LineageItem] # list of upstream entities | ||
allisonsuarez marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| lineage_entities_downstream: List[LineageItem] # list of downstream entities | ||
allisonsuarez marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
|
|
||
| class LineageSchema(AttrsSchema): | ||
| target = Lineage | ||
| register_as_scheme = True | ||
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
could you share some examples on this class? e.g what are the badges and usage using here?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just added the actual Badge class for badge list. Not sure what you mean by what the usage is using here?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
we can change
usageto be even more general and make it something likesorting_metricor something like that, but usage seems like a natural way in which we would want to highlight more important upstream/downstream resources when you have lots of themThere was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
My question is around how the metadata lineage entity connection will look like with badge and usage.