Skip to content
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.

Sign up for GitHub

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

Jump to bottom

docs: improve lineage docs #10396

Merged
merged 9 commits into from May 22, 2024
Merged

docs: improve lineage docs #10396

merged 9 commits into from May 22, 2024

Conversation

yoonhyejin
Copy link
Collaborator

Checklist

  • The PR conforms to DataHub's Contributing Guideline (particularly Commit Message Format)
  • Links to related issues (if applicable)
  • Tests for the changes have been added/updated (if applicable)
  • Docs related to the changes have been added/updated (if applicable). If a new feature has been added a Usage Guide has been added for the same.
  • For any breaking change/potential downtime/deprecation/big changes an entry has been made in Updating DataHub

@yoonhyejin yoonhyejin requested a review from hsheth2 April 29, 2024 12:20
@github-actions github-actions bot added ingestion PR or Issue related to the ingestion of metadata docs Issues and Improvements to docs labels Apr 29, 2024
yoonhyejin
yoonhyejin commented Apr 29, 2024
View reviewed changes
metadata-ingestion/examples/library/read_lineage_rest.py Outdated
"""
result = graph.execute_graphql(query=query)
urn = "urn:li:dataset:(urn:li:dataPlatform:hive,logging_events,PROD)"
result = graph.get_aspect(entity_urn=urn, aspect_type=UpstreamLineageClass)
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@hsheth2 let me know if this is the right aspect that we can use for reading lineage information

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The aspects vary by entity type, so might make sense to have a few examples

dataset -> upstreamlineage
datajob -> datajobinputoutputs
etc

You can find the mapping on our entity type docs https://datahubproject.io/docs/generated/metamodel/entities/datajob/#relationships

hsheth2
hsheth2 approved these changes May 2, 2024
View reviewed changes
metadata-ingestion/examples/library/read_lineage_execute_graphql.py Outdated Show resolved Hide resolved
metadata-ingestion/examples/library/read_lineage_rest.py Outdated Show resolved Hide resolved
metadata-ingestion/examples/library/read_lineage_rest.py Outdated
"""
result = graph.execute_graphql(query=query)
urn = "urn:li:dataset:(urn:li:dataPlatform:hive,logging_events,PROD)"
result = graph.get_aspect(entity_urn=urn, aspect_type=UpstreamLineageClass)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The aspects vary by entity type, so might make sense to have a few examples

dataset -> upstreamlineage
datajob -> datajobinputoutputs
etc

You can find the mapping on our entity type docs https://datahubproject.io/docs/generated/metamodel/entities/datajob/#relationships

@yoonhyejin yoonhyejin added the merge-pending-ci A PR that has passed review and should be merged once CI is green. label May 20, 2024
@yoonhyejin yoonhyejin merged commit ad3b8f9 into master May 22, 2024
58 checks passed
@yoonhyejin yoonhyejin deleted the docs/improve-lineage branch May 22, 2024 06:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@hsheth2 hsheth2 hsheth2 approved these changes

Assignees
No one assigned
Labels
docs Issues and Improvements to docs ingestion PR or Issue related to the ingestion of metadata merge-pending-ci A PR that has passed review and should be merged once CI is green.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@yoonhyejin @hsheth2