mirror of
https://github.com/datahub-project/datahub.git
synced 2025-07-11 19:23:02 +00:00
124 lines
61 KiB
HTML
124 lines
61 KiB
HTML
<!doctype html>
|
||
<html lang="en" dir="ltr" class="docs-wrapper docs-doc-page docs-version-current plugin-docs plugin-id-default docs-doc-id-python-sdk/sdk-v2/lineage-client" data-has-hydrated="false">
|
||
<head>
|
||
<meta charset="UTF-8">
|
||
<meta name="generator" content="Docusaurus v2.4.3">
|
||
<title data-rh="true">Lineage Client | DataHub</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://docs.datahub.com/docs/python-sdk/sdk-v2/lineage-client"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Lineage Client | DataHub"><meta data-rh="true" name="description" content="The DataHub Lineage Client provides a client for adding and retrieving lineage information from DataHub."><meta data-rh="true" property="og:description" content="The DataHub Lineage Client provides a client for adding and retrieving lineage information from DataHub."><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://docs.datahub.com/docs/python-sdk/sdk-v2/lineage-client"><link data-rh="true" rel="alternate" href="https://docs.datahub.com/docs/python-sdk/sdk-v2/lineage-client" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.datahub.com/docs/python-sdk/sdk-v2/lineage-client" hreflang="x-default"><link data-rh="true" rel="preconnect" href="https://RK0UG797F3-dsn.algolia.net" crossorigin="anonymous"><link rel="alternate" type="application/rss+xml" href="/learn/rss.xml" title="DataHub RSS Feed">
|
||
<link rel="alternate" type="application/atom+xml" href="/learn/atom.xml" title="DataHub Atom Feed">
|
||
|
||
<link rel="preconnect" href="https://www.google-analytics.com">
|
||
<link rel="preconnect" href="https://www.googletagmanager.com">
|
||
<script async src="https://www.googletagmanager.com/gtag/js?id=G-PKGVLETT4C"></script>
|
||
<script>function gtag(){dataLayer.push(arguments)}window.dataLayer=window.dataLayer||[],gtag("js",new Date),gtag("config","G-PKGVLETT4C",{})</script>
|
||
<link rel="preconnect" href="https://www.googletagmanager.com">
|
||
<script>window.dataLayer=window.dataLayer||[]</script>
|
||
<script>!function(e,t,a,n,g){e[n]=e[n]||[],e[n].push({"gtm.start":(new Date).getTime(),event:"gtm.js"});var m=t.getElementsByTagName(a)[0],r=t.createElement(a);r.async=!0,r.src="https://www.googletagmanager.com/gtm.js?id=GTM-5M8T9HNN",m.parentNode.insertBefore(r,m)}(window,document,"script","dataLayer")</script>
|
||
|
||
|
||
<link rel="search" type="application/opensearchdescription+xml" title="DataHub" href="/opensearch.xml">
|
||
|
||
|
||
|
||
|
||
<meta httpequiv="Content-Security-Policy" content="frame-ancestors 'self' https://*.acryl.io https://acryldata.io http://localhost:*">
|
||
<link rel="stylesheet" href="https://fonts.googleapis.com/css2?family=Manrope:wght@400;500;700&display=swap">
|
||
<script src="https://tools.luckyorange.com/core/lo.js?site-id=28ea8a38" async defer="defer"></script>
|
||
<script src="/scripts/rb2b.js" async defer="defer"></script>
|
||
<script src="https://app.revenuehero.io/scheduler.min.js"></script>
|
||
<script src="https://tag.clearbitscripts.com/v1/pk_2e321cabe30432a5c44c0424781aa35f/tags.js" referrerpolicy="strict-origin-when-cross-origin"></script>
|
||
<script src="/scripts/reo.js"></script>
|
||
<script id="runllm-widget-script" type="module" src="https://widget.runllm.com" crossorigin="true" runllm-name="DataHub" runllm-assistant-id="81" runllm-position="BOTTOM_RIGHT" runllm-keyboard-shortcut="Mod+j" runllm-preset="docusaurus" runllm-theme-color="#1890FF" runllm-brand-logo="https://docs.datahub.com/img/datahub-logo-color-mark.svg" runllm-community-url="https://datahub.com/slack" runllm-community-type="slack" runllm-disable-ask-a-person="true" async></script><link rel="stylesheet" href="/assets/css/styles.d8fe2eb8.css">
|
||
<link rel="preload" href="/assets/js/runtime~main.b1b0f962.js" as="script">
|
||
<link rel="preload" href="/assets/js/main.89423a85.js" as="script">
|
||
</head>
|
||
<body class="navigation-with-keyboard">
|
||
<noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-5M8T9HNN" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
|
||
|
||
<script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){var t=null;try{t=new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}return t}()||function(){var t=null;try{t=localStorage.getItem("theme")}catch(t){}return t}();t(null!==e?e:"light")}(),document.documentElement.setAttribute("data-announcement-bar-initially-dismissed",function(){try{return"true"===localStorage.getItem("docusaurus.announcement.dismiss")}catch(t){}return!1}())</script><div id="__docusaurus">
|
||
<div role="region" aria-label="Skip to main content"><a class="skipToContent_fXgn" href="#__docusaurus_skipToContent_fallback">Skip to main content</a></div><div class="announcementBar_mb4j" style="background-color:transparent;color:#ffffff" role="banner"><div class="content_knG7 announcementBarContent_xLdY"><div class="shimmer-banner"><p>DataHub Secures $35 Million Series B</p><a href="https://datahub.com/news/series-b-announcement/" target="_blank" class="button"><div>Read the announcement<span> →</span></div></a></div></div></div><nav aria-label="Main" class="navbar navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><button aria-label="Toggle navigation bar" aria-expanded="false" class="navbar__toggle clean-btn" type="button"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a href="https://datahub.com" target="_blank" rel="noopener noreferrer" class="navbar__brand"><div class="navbar__logo"><img src="/img/datahub-logo-color-light-horizontal.svg" alt="DataHub Logo" class="themedImage_ToTc themedImage--light_HNdA"><img src="/img/datahub-logo-color-dark-horizontal.svg" alt="DataHub Logo" class="themedImage_ToTc themedImage--dark_i4oU"></div></a><div class="navbar__item dropdown dropdown--hoverable"><a href="#" aria-haspopup="true" aria-expanded="false" role="button" class="navbar__link versionNavItem_cbn8">Next</a><ul class="dropdown__menu"><li><a aria-current="page" class="dropdown__link dropdown__link--active" href="/docs/python-sdk/sdk-v2/lineage-client">Next</a></li><li><a class="dropdown__link" href="/docs/1.1.0/features">1.1.0</a></li><li><hr class="dropdown-separator" style="margin: 0.4rem;"></li><li><div class="dropdown__link"><b>Archived versions</b></div></li><li>
|
||
<a class="dropdown__link" href="https://docs-website-t9sv4w3gr-acryldata.vercel.app/docs/features">1.0.0
|
||
<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg>
|
||
</a>
|
||
</li><li>
|
||
<a class="dropdown__link" href="https://docs-website-t9sv4w3gr-acryldata.vercel.app/docs/0.15.0/features">0.15.0
|
||
<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg>
|
||
</a>
|
||
</li><li>
|
||
<a class="dropdown__link" href="https://docs-website-8jkm4uler-acryldata.vercel.app/docs/0.14.1/features">0.14.1
|
||
<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg>
|
||
</a>
|
||
</li><li>
|
||
<a class="dropdown__link" href="https://docs-website-eue2qafvn-acryldata.vercel.app/docs/features">0.14.0
|
||
<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg>
|
||
</a>
|
||
</li><li>
|
||
<a class="dropdown__link" href="https://docs-website-psat3nzgi-acryldata.vercel.app/docs/features">0.13.1
|
||
<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg>
|
||
</a>
|
||
</li><li>
|
||
<a class="dropdown__link" href="https://docs-website-lzxh86531-acryldata.vercel.app/docs/features">0.13.0
|
||
<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg>
|
||
</a>
|
||
</li><li>
|
||
<a class="dropdown__link" href="https://docs-website-2uuxmgza2-acryldata.vercel.app/docs/features">0.12.1
|
||
<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg>
|
||
</a>
|
||
</li><li>
|
||
<a class="dropdown__link" href="https://docs-website-irpoe2osc-acryldata.vercel.app/docs/features">0.11.0
|
||
<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg>
|
||
</a>
|
||
</li><li>
|
||
<a class="dropdown__link" href="https://docs-website-1gv2yzn9d-acryldata.vercel.app/docs/features">0.10.5
|
||
<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg>
|
||
</a>
|
||
</li></ul></div></div><div class="navbar__items navbar__items--right"><a aria-current="page" class="navbar__item navbar__link navbar__link--active" href="/docs">Docs</a><a class="navbar__item navbar__link" href="/integrations">Integrations</a><div class="navbar__item dropdown dropdown--hoverable"><a href="#" aria-haspopup="true" aria-expanded="false" role="button" class="navbar__link">Learn</a><ul class="dropdown__menu dropdown__menu_Z8FC"><div class="wrapper_kp81"><div><a href="https://datahub.com/weekly-demo" target="_blank" rel="noopener noreferrer" class="card_BUD7"><div class="icon_BgHd"><img src="/img/icon-join-slack.png" alt="Weekly Demo"></div><div class="title_c7DP">Weekly Demo</div></a></div><div><a href="https://datahub.com/use-cases" target="_blank" rel="noopener noreferrer" class="card_BUD7"><div class="icon_BgHd"><img src="/img/icon-forum.png" alt="Use Cases"></div><div class="title_c7DP">Use Cases</div></a></div><div><a href="httpps://datahub.com/adoption-stories" target="_blank" rel="noopener noreferrer" class="card_BUD7"><div class="icon_BgHd"><img src="/img/icon-events.png" alt="Adoption Stories"></div><div class="title_c7DP">Adoption Stories</div></a></div><div><a href="https://medium.com/datahub-project" target="_blank" rel="noopener noreferrer" class="card_BUD7"><div class="icon_BgHd"><img src="/img/icon-champions.png" alt="Blog"></div><div class="title_c7DP">Blog</div></a></div><div><a href="https://www.youtube.com/channel/UC3qFQC5IiwR5fvWEqi_tJ5w" target="_blank" rel="noopener noreferrer" class="card_BUD7"><div class="icon_BgHd"><img src="/img/icon-share-your-journey.png" alt="Youtube"></div><div class="title_c7DP">Youtube</div></a></div></div></ul></div><div class="navbar__item dropdown dropdown--hoverable"><a href="#" aria-haspopup="true" aria-expanded="false" role="button" class="navbar__link">Community</a><ul class="dropdown__menu dropdown__menu_Z8FC"><div class="wrapper_kp81"><div><a href="https://datahub.com/slack/" target="_blank" rel="noopener noreferrer" class="card_BUD7"><div class="icon_BgHd"><img src="/img/icon-join-slack.png" alt="Join Slack"></div><div class="title_c7DP">Join Slack</div></a></div><div><a href="https://datahub.com/events" target="_blank" rel="noopener noreferrer" class="card_BUD7"><div class="icon_BgHd"><img src="/img/icon-events.png" alt="Events"></div><div class="title_c7DP">Events</div></a></div><div><a href="https://datahub.com/champions/" target="_blank" rel="noopener noreferrer" class="card_BUD7"><div class="icon_BgHd"><img src="/img/icon-champions.png" alt="Champions"></div><div class="title_c7DP">Champions</div></a></div><div><a href="https://datahub.com/share-your-journey/" target="_blank" rel="noopener noreferrer" class="card_BUD7"><div class="icon_BgHd"><img src="/img/icon-share-your-journey.png" alt="Share Your Journey"></div><div class="title_c7DP">Share Your Journey</div></a></div></div></ul></div><a href="https://datahub.com/products/why-datahub-cloud/" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">
|
||
<style>
|
||
.cloud-cta {
|
||
color: var(--ifm-menu-color-active);
|
||
font-weight: 600;
|
||
background: linear-gradient(40deg, var(--ifm-menu-color-active), var(--ifm-menu-color-active));
|
||
background-size: 200% 100%;
|
||
-webkit-background-clip: text;
|
||
background-clip: text;
|
||
transition: background-image 0.3s ease;
|
||
}
|
||
.cloud-cta:hover {
|
||
color: transparent;
|
||
background: linear-gradient(40deg, var(--ifm-menu-color-active), #ff1493);
|
||
background-size: 200% 100%;
|
||
-webkit-background-clip: text;
|
||
background-clip: text;
|
||
animation: gradientShift 3s ease infinite;
|
||
}
|
||
@keyframes gradientShift {
|
||
0%, 100% { background-position: 0% 50%; }
|
||
50% { background-position: 100% 50%; }
|
||
}
|
||
</style>
|
||
<div class="cloud-cta">Get Cloud</div>
|
||
</a><a href="https://datahub.com/slack?utm_source=docs&utm_medium=header&utm_campaign=docs_header" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">
|
||
<style>
|
||
.slack-logo:hover {
|
||
opacity: 0.8;
|
||
}
|
||
</style>
|
||
<img class="slack-logo" src="https://upload.wikimedia.org/wikipedia/commons/d/d5/Slack_icon_2019.svg" , alt="slack" , height="20px" style="margin: 10px 0 0 0;">
|
||
</a><div class="searchBox_ZlJk"><button type="button" class="DocSearch DocSearch-Button" aria-label="Search"><span class="DocSearch-Button-Container"><svg width="20" height="20" class="DocSearch-Search-Icon" viewBox="0 0 20 20" aria-hidden="true"><path d="M14.386 14.386l4.0877 4.0877-4.0877-4.0877c-2.9418 2.9419-7.7115 2.9419-10.6533 0-2.9419-2.9418-2.9419-7.7115 0-10.6533 2.9418-2.9419 7.7115-2.9419 10.6533 0 2.9419 2.9418 2.9419 7.7115 0 10.6533z" stroke="currentColor" fill="none" fill-rule="evenodd" stroke-linecap="round" stroke-linejoin="round"></path></svg><span class="DocSearch-Button-Placeholder">Search</span></span><span class="DocSearch-Button-Keys"></span></button></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div id="__docusaurus_skipToContent_fallback" class="main-wrapper mainWrapper_z2l0 docsWrapper_BCFX"><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_sjWU" type="button"></button><div class="docPage__5DB"><aside class="theme-doc-sidebar-container docSidebarContainer_b6E3"><div class="sidebarViewport_Xe31"><div class="sidebar_njMd"><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_SIkG menuWithAnnouncementBar_GW3s"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menuHtmlItem_M9Kj menu__list-item"><div>Getting Started</div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/docs/features">What Is DataHub?</a><button aria-label="Toggle the collapsible sidebar category 'What Is DataHub?'" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/docs/category/features">Features</a><button aria-label="Toggle the collapsible sidebar category 'Features'" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menuHtmlItem_M9Kj menu__list-item"><div>DataHub Cloud</div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/docs/managed-datahub/managed-datahub-overview">DataHub Cloud Overview</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/docs/managed-datahub/welcome-acryl">Getting Started with DataHub Cloud</a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/authentication/guides/sso/initialize-oidc">Configure Single Sign-On</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/managed-datahub/remote-executor/about">Remote Executor</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/managed-datahub/datahub-api/entity-events-api">DataHub API</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/managed-datahub/slack/saas-slack-app">Slack</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/managed-datahub/operator-guide/setting-up-events-api-on-aws-eventbridge">Operator Guides</a></div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item saasOnly"><a class="menu__link" href="/docs/managed-datahub/approval-workflows">Change Proposals & Approval Workflows</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/docs/managed-datahub/chrome-extension">Cloud Chrome Extension</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item saasOnly"><a class="menu__link" href="/docs/managed-datahub/subscription-and-notification">Subscriptions & Notifications</a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/managed-datahub/release-notes/v_0_3_12">DataHub Cloud Release History</a></div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menuHtmlItem_M9Kj menu__list-item"><div>Integrations</div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/docs/metadata-ingestion">Overview</a><button aria-label="Toggle the collapsible sidebar category 'Overview'" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/metadata-ingestion/cli-ingestion">Quickstart Guides</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/docs/metadata-ingestion/source_overview">Sources</a><button aria-label="Toggle the collapsible sidebar category 'Sources'" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/metadata-ingestion/schedule_docs/intro">Advanced Guides</a></div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menuHtmlItem_M9Kj menu__list-item"><div>API & SDKs</div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/metadata-modeling/metadata-model">DataHub's Open Metadata Standard</a></div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/docs/what-is-datahub/datahub-concepts">Concepts</a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/docs/metadata-standards">Metadata Standards</a><button aria-label="Toggle the collapsible sidebar category 'Metadata Standards'" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/docs/api/datahub-apis">APIs and SDKs Overview</a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/api/graphql/overview">API</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret menu__link--active" aria-expanded="true" href="/docs/metadata-ingestion/as-a-library">Python SDK</a></div><ul style="display:block;overflow:visible;height:auto" class="menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/metadata-ingestion/as-a-library">Python Emitter</a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret menu__link--active" aria-expanded="true" tabindex="0" href="/docs/python-sdk/builder/mce-builder">SDK Reference</a></div><ul style="display:block;overflow:visible;height:auto" class="menu__list"><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-3 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" tabindex="0" href="/docs/python-sdk/builder/mce-builder">Builder</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-3 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" tabindex="0" href="/docs/python-sdk/clients/graph-client">Clients</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-3 menu__list-item"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret menu__link--active" aria-expanded="true" tabindex="0" href="/docs/python-sdk/sdk-v2/entities">SDK V2</a></div><ul style="display:block;overflow:visible;height:auto" class="menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-4 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/python-sdk/sdk-v2/entities">Entities</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-4 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/python-sdk/sdk-v2/entity-client">Entity Client</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-4 menu__list-item"><a class="menu__link menu__link--active" aria-current="page" tabindex="0" href="/docs/python-sdk/sdk-v2/lineage-client">Lineage Client</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-4 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/python-sdk/sdk-v2/main-client">Main Client</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-4 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/python-sdk/sdk-v2/resolver-client">Resolver Client</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-4 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/python-sdk/sdk-v2/search-client">Search Client</a></li></ul></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/python-sdk/models">Models</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/python-sdk/urns">URNs</a></li></ul></li></ul></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/docs/metadata-integration/java/as-a-library">Java SDK</a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/docs/cli">DataHub CLI</a><button aria-label="Toggle the collapsible sidebar category 'DataHub CLI'" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/docs/act-on-metadata">DataHub Actions</a><button aria-label="Toggle the collapsible sidebar category 'DataHub Actions'" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/api/tutorials/datasets">Guides</a></div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menuHtmlItem_M9Kj menu__list-item"><div>Admin</div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/authentication">Authentication</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/authorization">Authorization</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/how/delete-metadata">Advanced Guides</a></div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menuHtmlItem_M9Kj menu__list-item"><div>Deployment</div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/docs/category/deployment-guides">Deployment Guides</a><button aria-label="Toggle the collapsible sidebar category 'Deployment Guides'" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/deploy/confluent-cloud">Advanced Guides</a></div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menuHtmlItem_M9Kj menu__list-item"><div>Developers</div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/architecture/architecture">Architecture</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/developers">Developing on DataHub</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/advanced/mcp-mcl">Advanced Guides</a></div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menuHtmlItem_M9Kj menu__list-item"><div>Community</div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/docs/category/community">Community</a><button aria-label="Toggle the collapsible sidebar category 'Community'" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/releases">Release History</a></div></li></ul></nav></div></div></aside><main class="docMainContainer_gTbr"><div class="container padding-top--md padding-bottom--lg"><div class="row"><div class="col docItemCol_VOVn"><div class="docItemContainer_Djhp"><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_Z_bl" aria-label="Breadcrumbs"><ul class="breadcrumbs" itemscope="" itemtype="https://schema.org/BreadcrumbList"><li class="breadcrumbs__item"><a aria-label="Home page" class="breadcrumbs__link" href="/"><svg viewBox="0 0 24 24" class="breadcrumbHomeIcon_YNFT"><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill="currentColor"></path></svg></a></li><li class="breadcrumbs__item"><span class="breadcrumbs__link">Python SDK</span><meta itemprop="position" content="1"></li><li class="breadcrumbs__item"><span class="breadcrumbs__link">SDK Reference</span><meta itemprop="position" content="2"></li><li class="breadcrumbs__item"><span class="breadcrumbs__link">SDK V2</span><meta itemprop="position" content="3"></li><li itemscope="" itemprop="itemListElement" itemtype="https://schema.org/ListItem" class="breadcrumbs__item breadcrumbs__item--active"><span class="breadcrumbs__link" itemprop="name">Lineage Client</span><meta itemprop="position" content="4"></li></ul></nav><span class="theme-doc-version-badge badge badge--secondary">Version: Next</span><div class="tocCollapsible_ETCw theme-doc-toc-mobile tocMobile_ITEo"><button type="button" class="clean-btn tocCollapsibleButton_TO0P">On this page</button></div><div class="theme-doc-markdown markdown"><header><h1>Lineage Client</h1></header><div class="sphinx-api-docs"><a id="lineage-client"></a><p>The DataHub Lineage Client provides a client for adding and retrieving lineage information from DataHub.</p><p>If you’re looking for higher-level introduction to adding and getting lineage using the SDK, see the <a href="/docs/api/tutorials/lineage">lineage guide</a>.</p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.sdk.lineage_client.LineageClient"><span class="visually-hidden">LineageClient</span><a href="#datahub.sdk.lineage_client.LineageClient" class="hash-link" aria-label="Direct link to datahub.sdk.lineage_client.LineageClient" title="Direct link to datahub.sdk.lineage_client.LineageClient"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.sdk.lineage_client.</span><span class="class-name">LineageClient</span>(<span class="arg-name">client</span>)<a href="#datahub.sdk.lineage_client.LineageClient" class="hash-link"></a></div><p>Bases: <code>object</code></p><ul><li><strong>Parameters:</strong><strong>client</strong> (<a href="/docs/python-sdk/sdk-v2/main-client#datahub.sdk.main_client.DataHubClient"><code>DataHubClient</code></a>) – </li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="add_datajob_lineage-datajob-upstreamsnone-downstreamsnone">add_datajob_lineage(<!-- -->*<!-- -->, datajob, upstreams=None, downstreams=None)<a href="#add_datajob_lineage-datajob-upstreamsnone-downstreamsnone" class="hash-link" aria-label="Direct link to add_datajob_lineage-datajob-upstreamsnone-downstreamsnone" title="Direct link to add_datajob_lineage-datajob-upstreamsnone-downstreamsnone"></a></h4><p>Add lineage between a datajob and datasets/datajobs.</p><ul><li><strong>Parameters:</strong><ul><li><strong>datajob</strong> (<code>Union</code>[<code>str</code>, <a href="/docs/python-sdk/urns#datahub.metadata.urns.DataJobUrn"><code>DataJobUrn</code></a>]) – The datajob URN to connect lineage with</li><li><strong>upstreams</strong> (<code>Optional</code>[<code>List</code>[<code>Union</code>[<code>str</code>, <a href="/docs/python-sdk/urns#datahub.metadata.urns.DatasetUrn"><code>DatasetUrn</code></a>, <a href="/docs/python-sdk/urns#datahub.metadata.urns.DataJobUrn"><code>DataJobUrn</code></a>]]]) – List of upstream datasets or datajobs that serve as inputs to the datajob</li><li><strong>downstreams</strong> (<code>Optional</code>[<code>List</code>[<code>Union</code>[<code>str</code>, <a href="/docs/python-sdk/urns#datahub.metadata.urns.DatasetUrn"><code>DatasetUrn</code></a>]]]) – List of downstream datasets that are outputs of the datajob</li></ul></li><li><strong>Return type:</strong><code>None</code></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="add_dataset_copy_lineage-upstream-downstream-column_lineageauto_fuzzy">add_dataset_copy_lineage(<!-- -->*<!-- -->, upstream, downstream, column_lineage='auto_fuzzy')<a href="#add_dataset_copy_lineage-upstream-downstream-column_lineageauto_fuzzy" class="hash-link" aria-label="Direct link to add_dataset_copy_lineage-upstream-downstream-column_lineageauto_fuzzy" title="Direct link to add_dataset_copy_lineage-upstream-downstream-column_lineageauto_fuzzy"></a></h4><ul><li><strong>Parameters:</strong><ul><li><strong>upstream</strong> (<code>Union</code>[<code>str</code>, <a href="/docs/python-sdk/urns#datahub.metadata.urns.DatasetUrn"><code>DatasetUrn</code></a>]) – </li><li><strong>downstream</strong> (<code>Union</code>[<code>str</code>, <a href="/docs/python-sdk/urns#datahub.metadata.urns.DatasetUrn"><code>DatasetUrn</code></a>]) – </li><li><strong>column_lineage</strong> (<code>Union</code>[<code>None</code>, <code>Dict</code>[<code>str</code>, <code>List</code>[<code>str</code>]<!-- -->], <code>Literal</code>[<code>'auto_fuzzy'</code>, <code>'auto_strict'</code>]<!-- -->])</li></ul></li><li><strong>Return type:</strong><code>None</code></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="add_dataset_transform_lineage-upstream-downstream-column_lineagenone-transformation_textnone">add_dataset_transform_lineage(<!-- -->*<!-- -->, upstream, downstream, column_lineage=None, transformation_text=None)<a href="#add_dataset_transform_lineage-upstream-downstream-column_lineagenone-transformation_textnone" class="hash-link" aria-label="Direct link to add_dataset_transform_lineage-upstream-downstream-column_lineagenone-transformation_textnone" title="Direct link to add_dataset_transform_lineage-upstream-downstream-column_lineagenone-transformation_textnone"></a></h4><ul><li><strong>Parameters:</strong><ul><li><strong>upstream</strong> (<code>Union</code>[<code>str</code>, <a href="/docs/python-sdk/urns#datahub.metadata.urns.DatasetUrn"><code>DatasetUrn</code></a>]) – </li><li><strong>downstream</strong> (<code>Union</code>[<code>str</code>, <a href="/docs/python-sdk/urns#datahub.metadata.urns.DatasetUrn"><code>DatasetUrn</code></a>]) – </li><li><strong>column_lineage</strong> (<code>Optional</code>[<code>Dict</code>[<code>str</code>, <code>List</code>[<code>str</code>]<!-- -->]])</li><li><strong>transformation_text</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li></ul></li><li><strong>Return type:</strong><code>None</code></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="add_lineage-upstream-downstream-column_lineagefalse-transformation_textnone">add_lineage(<!-- -->*<!-- -->, upstream, downstream, column_lineage=False, transformation_text=None)<a href="#add_lineage-upstream-downstream-column_lineagefalse-transformation_textnone" class="hash-link" aria-label="Direct link to add_lineage-upstream-downstream-column_lineagefalse-transformation_textnone" title="Direct link to add_lineage-upstream-downstream-column_lineagefalse-transformation_textnone"></a></h4><p>Add lineage between two entities.</p><p>This flexible method handles different combinations of entity types:</p><ul><li>dataset to dataset</li><li>dataset to datajob</li><li>datajob to dataset</li><li>datajob to datajob</li><li>dashboard to dataset</li><li>dashboard to chart</li><li>dashboard to dashboard</li><li>dataset to chart</li></ul><ul><li><strong>Parameters:</strong><ul><li><strong>upstream</strong> (<code>Union</code>[<code>str</code>, <a href="/docs/python-sdk/urns#datahub.metadata.urns.DatasetUrn"><code>DatasetUrn</code></a>, <a href="/docs/python-sdk/urns#datahub.metadata.urns.DataJobUrn"><code>DataJobUrn</code></a>, <a href="/docs/python-sdk/urns#datahub.metadata.urns.DashboardUrn"><code>DashboardUrn</code></a>, <a href="/docs/python-sdk/urns#datahub.metadata.urns.ChartUrn"><code>ChartUrn</code></a>]) – URN of the upstream entity (dataset or datajob)</li><li><strong>downstream</strong> (<code>Union</code>[<code>str</code>, <a href="/docs/python-sdk/urns#datahub.metadata.urns.DatasetUrn"><code>DatasetUrn</code></a>, <a href="/docs/python-sdk/urns#datahub.metadata.urns.DataJobUrn"><code>DataJobUrn</code></a>, <a href="/docs/python-sdk/urns#datahub.metadata.urns.DashboardUrn"><code>DashboardUrn</code></a>, <a href="/docs/python-sdk/urns#datahub.metadata.urns.ChartUrn"><code>ChartUrn</code></a>]) – URN of the downstream entity (dataset or datajob)</li><li><strong>column_lineage</strong> (<code>Union</code>[<code>bool</code>, <code>Dict</code>[<code>str</code>, <code>List</code>[<code>str</code>]<!-- -->], <code>Literal</code>[<code>'auto_fuzzy'</code>, <code>'auto_strict'</code>]<!-- -->]) – Optional boolean to indicate if column-level lineage should be added or a lineage mapping type (auto_fuzzy, auto_strict, or a mapping of column-level lineage)</li><li><strong>transformation_text</strong> (<code>Optional</code>[<code>str</code>]<!-- -->) – Optional SQL query text that defines the transformation
|
||
(only applicable for dataset-to-dataset lineage)</li></ul></li><li><strong>Raises:</strong><ul><li><strong>InvalidUrnError</strong> – If the URNs provided are invalid</li><li><strong>SdkUsageError</strong> – If certain parameter combinations are not supported</li></ul></li><li><strong>Return type:</strong><code>None</code></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="get_lineage-source_urn-source_columnnone-directionupstream-max_hops1-filternone-count500">get_lineage(<!-- -->*<!-- -->, source_urn, source_column=None, direction='upstream', max_hops=1, filter=None, count=500)<a href="#get_lineage-source_urn-source_columnnone-directionupstream-max_hops1-filternone-count500" class="hash-link" aria-label="Direct link to get_lineage-source_urn-source_columnnone-directionupstream-max_hops1-filternone-count500" title="Direct link to get_lineage-source_urn-source_columnnone-directionupstream-max_hops1-filternone-count500"></a></h4><p>Retrieve lineage entities connected to a source entity.
|
||
:type source_urn: <code>Union</code>[<code>str</code>, <a href="/docs/python-sdk/urns#datahub.metadata.urns.Urn"><code>Urn</code></a>]
|
||
:param source_urn: Source URN for the lineage search
|
||
:type source_column: <code>Optional</code>[<code>str</code>]<!-- -->
|
||
:param source_column: Source column for the lineage search
|
||
:type direction: <code>Literal</code>[<code>'upstream'</code>, <code>'downstream'</code>]<!-- -->
|
||
:param direction: Direction of lineage traversal
|
||
:type max_hops: <code>int</code>
|
||
:param max_hops: Maximum number of hops to traverse
|
||
:type filter: <code>Union</code>[<code>_And</code>, <code>_Or</code>, <code>_Not</code>, <code>_EntityTypeFilter</code>, <code>_EntitySubtypeFilter</code>, <code>_StatusFilter</code>, <code>_PlatformFilter</code>, <code>_DomainFilter</code>, <code>_EnvFilter</code>, <code>_CustomCondition</code>, <code>None</code>]<!-- -->
|
||
:param filter: Filters to apply to the lineage search
|
||
:type count: <code>int</code>
|
||
:param count: Maximum number of results to return</p><ul><li><strong>Return type:</strong><code>List</code>[<a href="#datahub.sdk.lineage_client.LineageResult"><code>LineageResult</code></a>]</li><li><strong>Returns:</strong>
|
||
List of lineage results</li><li><strong>Raises:</strong><strong>SdkUsageError for invalid filter values</strong> – </li><li><strong>Parameters:</strong><ul><li><strong>source_urn</strong> (<em>str</em> <em>|</em> <a href="/docs/python-sdk/urns#datahub.metadata.urns.Urn"><em>Urn</em></a>) – </li><li><strong>source_column</strong> (<em>str</em> <em>|</em> <em>None</em>)</li><li><strong>direction</strong> (<em>Literal</em> <em>[</em> <em>'upstream'</em> <em>,<strong>'downstream'</strong>]</em>)</li><li><strong>max_hops</strong> (<em>int</em>)</li><li><strong>filter</strong> ( <em>_<!-- -->And</em> <em>|</em> <em>_<!-- -->Or</em> <em>|</em> <em>_<!-- -->Not</em> <em>|</em> <em>_<!-- -->EntityTypeFilter</em> <em>|</em> <em>_<!-- -->EntitySubtypeFilter</em> <em>|</em> <em>_<!-- -->StatusFilter</em> <em>|</em> <em>_<!-- -->PlatformFilter</em> <em>|</em> <em>_<!-- -->DomainFilter</em> <em>|</em> <em>_<!-- -->EnvFilter</em> <em>|</em> <em>_<!-- -->CustomCondition</em> <em>|</em> <em>None</em>)</li><li><strong>count</strong> (<em>int</em>)</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="infer_lineage_from_sql-query_text-platform-platform_instancenone-envprod-default_dbnone-default_schemanone-override_dialectnone">infer_lineage_from_sql(<!-- -->*<!-- -->, query_text, platform, platform_instance=None, env='PROD', default_db=None, default_schema=None, override_dialect=None)<a href="#infer_lineage_from_sql-query_text-platform-platform_instancenone-envprod-default_dbnone-default_schemanone-override_dialectnone" class="hash-link" aria-label="Direct link to infer_lineage_from_sql-query_text-platform-platform_instancenone-envprod-default_dbnone-default_schemanone-override_dialectnone" title="Direct link to infer_lineage_from_sql-query_text-platform-platform_instancenone-envprod-default_dbnone-default_schemanone-override_dialectnone"></a></h4><p>Add lineage by parsing a SQL query.</p><ul><li><strong>Parameters:</strong><ul><li><strong>query_text</strong> (<code>str</code>)</li><li><strong>platform</strong> (<code>str</code>)</li><li><strong>platform_instance</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>env</strong> (<code>str</code>)</li><li><strong>default_db</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>default_schema</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>override_dialect</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li></ul></li><li><strong>Return type:</strong><code>None</code></li></ul></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.sdk.lineage_client.LineagePath"><span class="visually-hidden">LineagePath</span><a href="#datahub.sdk.lineage_client.LineagePath" class="hash-link" aria-label="Direct link to datahub.sdk.lineage_client.LineagePath" title="Direct link to datahub.sdk.lineage_client.LineagePath"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.sdk.lineage_client.</span><span class="class-name">LineagePath</span>(<span class="arg-name">urn</span>, <span class="arg-name">entity_name</span>, <span class="arg-name">column_name</span> = <span class="arg-default">None</span>)<a href="#datahub.sdk.lineage_client.LineagePath" class="hash-link"></a></div><p>Bases: <code>object</code></p><ul><li><strong>Parameters:</strong><ul><li><strong>urn</strong> (<code>str</code>)</li><li><strong>entity_name</strong> (<code>str</code>)</li><li><strong>column_name</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="column_name--optionalstr--none">column_name <em>: <code>Optional</code>[<code>str</code>]</em> <em>= None</em><a href="#column_name--optionalstr--none" class="hash-link" aria-label="Direct link to column_name--optionalstr--none" title="Direct link to column_name--optionalstr--none"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="entity_name--str">entity_name <em>: <code>str</code></em><a href="#entity_name--str" class="hash-link" aria-label="Direct link to entity_name--str" title="Direct link to entity_name--str"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="urn--str">urn <em>: <code>str</code></em><a href="#urn--str" class="hash-link" aria-label="Direct link to urn--str" title="Direct link to urn--str"></a></h4></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.sdk.lineage_client.LineageResult"><span class="visually-hidden">LineageResult</span><a href="#datahub.sdk.lineage_client.LineageResult" class="hash-link" aria-label="Direct link to datahub.sdk.lineage_client.LineageResult" title="Direct link to datahub.sdk.lineage_client.LineageResult"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.sdk.lineage_client.</span><span class="class-name">LineageResult</span>(<span class="arg-name">urn</span>, <span class="arg-name">type</span>, <span class="arg-name">hops</span>, <span class="arg-name">direction</span>, <span class="arg-name">platform</span> = <span class="arg-default">None</span>, <span class="arg-name">name</span> = <span class="arg-default">None</span>, <span class="arg-name">description</span> = <span class="arg-default">None</span>, <span class="arg-name">paths</span> = <span class="arg-default">None</span>)<a href="#datahub.sdk.lineage_client.LineageResult" class="hash-link"></a></div><p>Bases: <code>object</code></p><ul><li><strong>Parameters:</strong><ul><li><strong>urn</strong> (<code>str</code>)</li><li><strong>type</strong> (<code>str</code>)</li><li><strong>hops</strong> (<code>int</code>)</li><li><strong>direction</strong> (<code>Literal</code>[<code>'upstream'</code>, <code>'downstream'</code>]<!-- -->)</li><li><strong>platform</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>name</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>description</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>paths</strong> (<code>Optional</code>[<code>List</code>[<a href="#datahub.sdk.lineage_client.LineagePath"><code>LineagePath</code></a>]]) – </li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="description--optionalstr--none">description <em>: <code>Optional</code>[<code>str</code>]</em> <em>= None</em><a href="#description--optionalstr--none" class="hash-link" aria-label="Direct link to description--optionalstr--none" title="Direct link to description--optionalstr--none"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="direction--literalupstream-downstream">direction <em>: <code>Literal</code>[<code>'upstream'</code>, <code>'downstream'</code>]</em><a href="#direction--literalupstream-downstream" class="hash-link" aria-label="Direct link to direction--literalupstream-downstream" title="Direct link to direction--literalupstream-downstream"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="hops--int">hops <em>: <code>int</code></em><a href="#hops--int" class="hash-link" aria-label="Direct link to hops--int" title="Direct link to hops--int"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="name--optionalstr--none">name <em>: <code>Optional</code>[<code>str</code>]</em> <em>= None</em><a href="#name--optionalstr--none" class="hash-link" aria-label="Direct link to name--optionalstr--none" title="Direct link to name--optionalstr--none"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="paths--optionallistlineagepath--none">paths <em>: <code>Optional</code>[<code>List</code>[<a href="#datahub.sdk.lineage_client.LineagePath"><code>LineagePath</code></a>]]</em> <em>= None</em><a href="#paths--optionallistlineagepath--none" class="hash-link" aria-label="Direct link to paths--optionallistlineagepath--none" title="Direct link to paths--optionallistlineagepath--none"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="platform--optionalstr--none">platform <em>: <code>Optional</code>[<code>str</code>]</em> <em>= None</em><a href="#platform--optionalstr--none" class="hash-link" aria-label="Direct link to platform--optionalstr--none" title="Direct link to platform--optionalstr--none"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="type--str">type <em>: <code>str</code></em><a href="#type--str" class="hash-link" aria-label="Direct link to type--str" title="Direct link to type--str"></a></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="urn--str-1">urn <em>: <code>str</code></em><a href="#urn--str-1" class="hash-link" aria-label="Direct link to urn--str-1" title="Direct link to urn--str-1"></a></h4></div></div></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="slackUtm_uoBr"><div class="slackUtm_uoBr"><hr>Need more help? Join the conversation in <a href="https://datahub.com/slack?utm_source=docs&utm_medium=footer&utm_campaign=docs_footer&utm_content=python-sdk/sdk-v2/lineage-client">Slack!</a></div></div><div class="theme-doc-footer-edit-meta-row row"><div class="col"><a href="https://github.com/datahub-project/datahub/blob/master/genDocs/python-sdk/sdk-v2/lineage-client.mdx" target="_blank" rel="noreferrer noopener" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_VsjB"></div></div></footer><div class="feedbackWrapper_mUHF"><div class="feedbackWidget_PX4d"><div class="feedbackButtons_wn3V"><strong>Is this page helpful?</strong><div><button class="feedbackButton_UgQs"><span role="img" aria-label="like" class="anticon anticon-like"><svg viewBox="64 64 896 896" focusable="false" data-icon="like" width="1em" height="1em" fill="currentColor" aria-hidden="true"><path d="M885.9 533.7c16.8-22.2 26.1-49.4 26.1-77.7 0-44.9-25.1-87.4-65.5-111.1a67.67 67.67 0 00-34.3-9.3H572.4l6-122.9c1.4-29.7-9.1-57.9-29.5-79.4A106.62 106.62 0 00471 99.9c-52 0-98 35-111.8 85.1l-85.9 311H144c-17.7 0-32 14.3-32 32v364c0 17.7 14.3 32 32 32h601.3c9.2 0 18.2-1.8 26.5-5.4 47.6-20.3 78.3-66.8 78.3-118.4 0-12.6-1.8-25-5.4-37 16.8-22.2 26.1-49.4 26.1-77.7 0-12.6-1.8-25-5.4-37 16.8-22.2 26.1-49.4 26.1-77.7-.2-12.6-2-25.1-5.6-37.1zM184 852V568h81v284h-81zm636.4-353l-21.9 19 13.9 25.4a56.2 56.2 0 016.9 27.3c0 16.5-7.2 32.2-19.6 43l-21.9 19 13.9 25.4a56.2 56.2 0 016.9 27.3c0 16.5-7.2 32.2-19.6 43l-21.9 19 13.9 25.4a56.2 56.2 0 016.9 27.3c0 22.4-13.2 42.6-33.6 51.8H329V564.8l99.5-360.5a44.1 44.1 0 0142.2-32.3c7.6 0 15.1 2.2 21.1 6.7 9.9 7.4 15.2 18.6 14.6 30.5l-9.6 198.4h314.4C829 418.5 840 436.9 840 456c0 16.5-7.2 32.1-19.6 43z"></path></svg></span></button><button class="feedbackButton_UgQs"><span role="img" aria-label="dislike" class="anticon anticon-dislike"><svg viewBox="64 64 896 896" focusable="false" data-icon="dislike" width="1em" height="1em" fill="currentColor" aria-hidden="true"><path d="M885.9 490.3c3.6-12 5.4-24.4 5.4-37 0-28.3-9.3-55.5-26.1-77.7 3.6-12 5.4-24.4 5.4-37 0-28.3-9.3-55.5-26.1-77.7 3.6-12 5.4-24.4 5.4-37 0-51.6-30.7-98.1-78.3-118.4a66.1 66.1 0 00-26.5-5.4H144c-17.7 0-32 14.3-32 32v364c0 17.7 14.3 32 32 32h129.3l85.8 310.8C372.9 889 418.9 924 470.9 924c29.7 0 57.4-11.8 77.9-33.4 20.5-21.5 31-49.7 29.5-79.4l-6-122.9h239.9c12.1 0 23.9-3.2 34.3-9.3 40.4-23.5 65.5-66.1 65.5-111 0-28.3-9.3-55.5-26.1-77.7zM184 456V172h81v284h-81zm627.2 160.4H496.8l9.6 198.4c.6 11.9-4.7 23.1-14.6 30.5-6.1 4.5-13.6 6.8-21.1 6.7a44.28 44.28 0 01-42.2-32.3L329 459.2V172h415.4a56.85 56.85 0 0133.6 51.8c0 9.7-2.3 18.9-6.9 27.3l-13.9 25.4 21.9 19a56.76 56.76 0 0119.6 43c0 9.7-2.3 18.9-6.9 27.3l-13.9 25.4 21.9 19a56.76 56.76 0 0119.6 43c0 9.7-2.3 18.9-6.9 27.3l-14 25.5 21.9 19a56.76 56.76 0 0119.6 43c0 19.1-11 37.5-28.8 48.4z"></path></svg></span></button></div></div></div></div></article><nav class="pagination-nav docusaurus-mt-lg" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/python-sdk/sdk-v2/entity-client"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Entity Client</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/python-sdk/sdk-v2/main-client"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Main Client</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#datahub.sdk.lineage_client.LineageClient" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">LineageClient</span></a></li><li><a href="#datahub.sdk.lineage_client.LineagePath" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">LineagePath</span></a></li><li><a href="#datahub.sdk.lineage_client.LineageResult" class="table-of-contents__link toc-highlight"><span classname="visually-hidden">LineageResult</span></a></li></ul></div></div></div></div></main></div></div><footer class="footer footer--dark"><div class="container container-fluid"><div class="row footer__links"><div class="col footer__col"><div class="footer__title">Docs</div><ul class="footer__items clean-list"><li class="footer__item"><a class="footer__link-item" href="/docs/">Introduction</a></li><li class="footer__item"><a class="footer__link-item" href="/docs/quickstart">Quickstart</a></li></ul></div><div class="col footer__col"><div class="footer__title">Community</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://datahub.com/slack" target="_blank" rel="noopener noreferrer" class="footer__link-item">Slack<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a href="https://www.youtube.com/channel/UC3qFQC5IiwR5fvWEqi_tJ5w" target="_blank" rel="noopener noreferrer" class="footer__link-item">YouTube<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a href="https://medium.com/datahub-project" target="_blank" rel="noopener noreferrer" class="footer__link-item">Blog<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a class="footer__link-item" href="/docs/townhalls">Town Halls</a></li><li class="footer__item"><a href="https://datahub.com/adoption-stories/" target="_blank" rel="noopener noreferrer" class="footer__link-item">Adoption<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li></ul></div><div class="col footer__col"><div class="footer__title">More</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://demo.datahub.com/" target="_blank" rel="noopener noreferrer" class="footer__link-item">Demo</a></li><li class="footer__item"><a href="https://feature-requests.datahubproject.io/roadmap" target="_blank" rel="noopener noreferrer" class="footer__link-item">Roadmap<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a class="footer__link-item" href="/docs/contributing">Contributing</a></li><li class="footer__item"><a href="https://github.com/datahub-project/datahub" target="_blank" rel="noopener noreferrer" class="footer__link-item">GitHub<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a href="https://feature-requests.datahubproject.io/" target="_blank" rel="noopener noreferrer" class="footer__link-item">Feature Requests<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li></ul></div></div><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2015-2025 DataHub Project Authors.</div></div></div></footer></div>
|
||
<script src="/assets/js/runtime~main.b1b0f962.js"></script>
|
||
<script src="/assets/js/main.89423a85.js"></script>
|
||
</body>
|
||
</html> |