mirror of
https://github.com/datahub-project/datahub.git
synced 2025-07-13 20:21:33 +00:00
148 lines
104 KiB
HTML
148 lines
104 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/clients/graph-client" data-has-hydrated="false">
|
|||
|
|
<head>
|
|||
|
|
<meta charset="UTF-8">
|
|||
|
|
<meta name="generator" content="Docusaurus v2.4.3">
|
|||
|
|
<title data-rh="true">Graph 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/clients/graph-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="Graph Client | DataHub"><meta data-rh="true" name="description" content="The DataHub graph client extends the Rest emitter with additional functionality."><meta data-rh="true" property="og:description" content="The DataHub graph client extends the Rest emitter with additional functionality."><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://docs.datahub.com/docs/python-sdk/clients/graph-client"><link data-rh="true" rel="alternate" href="https://docs.datahub.com/docs/python-sdk/clients/graph-client" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.datahub.com/docs/python-sdk/clients/graph-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.83fcf86b.js" as="script">
|
|||
|
|
<link rel="preload" href="/assets/js/main.bc908355.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/clients/graph-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--subli
|
|||
|
|
For example, when deleting a tag, you might use this to remove that tag from all other
|
|||
|
|
entities that reference it.</p><p>This does not delete the entity itself.</p><ul><li><strong>Parameters:</strong><ul><li><strong>urn</strong> (<code>str</code>) – The urn of the entity to delete references to.</li><li><strong>dry_run</strong> (<code>bool</code>) – If True, do not actually delete the references, just return the count of
|
|||
|
|
references and the list of related aspects.</li></ul></li><li><strong>Return type:</strong><code>Tuple</code>[<code>int</code>, <code>List</code>[<code>Dict</code>]<!-- -->]</li><li><strong>Returns:</strong>
|
|||
|
|
A tuple of (reference_count, sample of related_aspects).</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="emitallitems-run_id_datahub-graph-client">emit<em>all(items, run_id='</em>_<!-- -->datahub-graph-client')<a href="#emitallitems-run_id_datahub-graph-client" class="hash-link" aria-label="Direct link to emitallitems-run_id_datahub-graph-client" title="Direct link to emitallitems-run_id_datahub-graph-client"></a></h4><p>Emit all items in the iterable using multiple threads.</p><ul><li><strong>Parameters:</strong><ul><li><strong>items</strong> (<code>Iterable</code>[<code>Union</code>[<a href="/docs/python-sdk/models#datahub.metadata.schema_classes.MetadataChangeEventClass"><code>MetadataChangeEventClass</code></a>, <a href="/docs/python-sdk/models#datahub.metadata.schema_classes.MetadataChangeProposalClass"><code>MetadataChangeProposalClass</code></a>, <a href="/docs/python-sdk/builder/mcp-builder#datahub.emitter.mcp.MetadataChangeProposalWrapper"><code>MetadataChangeProposalWrapper</code></a>]]) – </li><li><strong>run_id</strong> (<code>str</code>)</li></ul></li><li><strong>Return type:</strong><code>None</code></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="execute_graphqlquery-variablesnone-operation_namenone-format_exceptiontrue">execute_graphql(query, variables=None, operation_name=None, format_exception=True)<a href="#execute_graphqlquery-variablesnone-operation_namenone-format_exceptiontrue" class="hash-link" aria-label="Direct link to execute_graphql(query, variables=None, operation_name=None, format_exception=True)" title="Direct link to execute_graphql(query, variables=None, operation_name=None, format_exception=True)"></a></h4><ul><li><strong>Parameters:</strong><ul><li><strong>query</strong> (<code>str</code>)</li><li><strong>variables</strong> (<code>Optional</code>[<code>Dict</code>]<!-- -->)</li><li><strong>operation_name</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>format_exception</strong> (<code>bool</code>)</li></ul></li><li><strong>Return type:</strong><code>Dict</code></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="existsentity_urn">exists(entity_urn)<a href="#existsentity_urn" class="hash-link" aria-label="Direct link to exists(entity_urn)" title="Direct link to exists(entity_urn)"></a></h4><ul><li><strong>Parameters:</strong><strong>entity_urn</strong> (<code>str</code>)</li><li><strong>Return type:</strong><code>bool</code></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="classmethod-from_emitteremitter"><em>classmethod</em> from_emitter(emitter)<a href="#classmethod-from_emitteremitter" class="hash-link" aria-label="Direct link to classmethod-from_emitteremitter" title="Direct link to classmethod-from_emitteremitter"></a></h4><ul><li><strong>Parameters:</strong><strong>emitter</strong> (<a href="/docs/python-sdk/clients/rest-emitter#datahub.emitter.rest_emitter.DataHubRestEmitter"><code>DataHubRestEmitter</code></a>) – </li><li><strong>Return type:</strong><a href="#datahub.ingestion.graph.client.DataHubGraph"><code>DataHubGraph</code></a></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="property-frontend_base_url--str"><em>property</em> frontend_base_url <em>: str</em><a href="#property-frontend_base_url--str" class="hash-link" aria-label="Direct link to property-frontend_base_url--str" title="Direct link to property-frontend_base_url--str"></a></h4><p>Get the public-facing base url of the frontend</p><p>This url can be used to construct links to the frontend. The url will not include a trailing slash.</p><p>Note: Only supported with DataHub Cloud.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="get_aspectentity_urn-aspect_type-version0">get_aspect(entity_urn, aspect_type, version=0)<a href="#get_aspectentity_urn-aspect_type-version0" class="hash-link" aria-label="Direct link to get_aspect(entity_urn, aspect_type, version=0)" title="Direct link to get_aspect(entity_urn, aspect_type, version=0)"></a></h4><p>Get an aspect for an entity.</p><ul><li><strong>Parameters:</s
|
|||
|
|
the Aspect as a dictionary if present, None if no aspect was found (HTTP status 404)</li><li><strong>Raises:</strong><ul><li><strong>TypeError</strong> – if the aspect type is a timeseries aspect</li><li><strong>HttpError</strong> – if the HTTP response is not a 200 or a 404</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="get_aspect_countsaspect-urn_likenone">get_aspect_counts(aspect, urn_like=None)<a href="#get_aspect_countsaspect-urn_likenone" class="hash-link" aria-label="Direct link to get_aspect_counts(aspect, urn_like=None)" title="Direct link to get_aspect_counts(aspect, urn_like=None)"></a></h4><ul><li><strong>Parameters:</strong><ul><li><strong>aspect</strong> (<code>str</code>)</li><li><strong>urn_like</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li></ul></li><li><strong>Return type:</strong><code>int</code></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="get_aspect_v2entity_urn-aspect_type-aspect-aspect_type_namenone-version0">get_aspect_v2(entity_urn, aspect_type, aspect, aspect_type_name=None, version=0)<a href="#get_aspect_v2entity_urn-aspect_type-aspect-aspect_type_namenone-version0" class="hash-link" aria-label="Direct link to get_aspect_v2(entity_urn, aspect_type, aspect, aspect_type_name=None, version=0)" title="Direct link to get_aspect_v2(entity_urn, aspect_type, aspect, aspect_type_name=None, version=0)"></a></h4><ul><li><strong>Parameters:</strong><ul><li><strong>entity_urn</strong> (<code>str</code>)</li><li><strong>aspect_type</strong> (<code>Type</code>[<code>TypeVar</code>(<code>Aspect</code>, bound= <code>_Aspect</code>)]<!-- -->) – </li><li><strong>aspect</strong> (<code>str</code>)</li><li><strong>aspect_type_name</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>version</strong> (<code>int</code>)</li></ul></li><li><strong>Return type:</strong><code>Optional</code>[<code>TypeVar</code>(<code>Aspect</code>, bound= <code>_Aspect</code>)]</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="get_aspects_for_entityentity_urn-aspects-aspect_types">get_aspects_for_entity(entity_urn, aspects, aspect_types)<a href="#get_aspects_for_entityentity_urn-aspects-aspect_types" class="hash-link" aria-label="Direct link to get_aspects_for_entity(entity_urn, aspects, aspect_types)" title="Direct link to get_aspects_for_entity(entity_urn, aspects, aspect_types)"></a></h4><p>Get multiple aspects for an entity.</p><p>Deprecated in favor of get_aspect (single aspect) or get_entity_semityped (full
|
|||
|
|
entity without manually specifying a list of aspects).</p><p>Warning: Do not use this method to determine if an entity exists!
|
|||
|
|
This method will always return an entity, even if it doesn’t exist. This is an issue with how DataHub server
|
|||
|
|
responds to these calls, and will be fixed automatically when the server-side issue is fixed.</p><ul><li><strong>Parameters:</strong><ul><li><strong>entity_urn</strong> (<code>str</code>) – The urn of the entity</li><li><strong>aspects</strong> (<code>List</code>[<code>str</code>]<!-- -->) – List of aspect names being requested (e.g. <!-- -->[schemaMetadata, datasetProperties]<!-- -->)</li><li><strong>aspect_types</strong> (<code>List</code>[<code>Type</code>[<code>TypeVar</code>(<code>Aspect</code>, bound= <code>_Aspect</code>)]<!-- -->]) – List of aspect type classes being requested (e.g. <!-- -->[datahub.metadata.schema_classes.DatasetProperties]<!-- -->)</li><li><strong>entity_urn</strong> – </li></ul></li><li><strong>Return type:</strong><code>Dict</code>[<code>str</code>, <code>Optional</code>[<code>TypeVar</code>(<code>Aspect</code>, bound= <code>_Aspect</code>)]<!-- -->]</li><li><strong>Returns:</strong>
|
|||
|
|
Optionally, a map of aspect_name to aspect_value as a dictionary if present, aspect_value will be set to None if that aspect was not found. Returns None on HTTP status 404.</li><li><strong>Raises:</strong><strong>HttpError</strong> – if the HTTP response is not a 200</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="get_browse_pathentity_urn">get_browse_path(entity_urn)<a href="#get_browse_pathentity_urn" class="hash-link" aria-label="Direct link to get_browse_path(entity_urn)" title="Direct link to get_browse_path(entity_urn)"></a></h4><ul><li><strong>Parameters:</strong><strong>entity_urn</strong> (<code>str</code>)</li><li><strong>Return type:</strong><code>Optional</code>[<a href="/docs/python-sdk/models#datahub.metadata.schema_classes.BrowsePathsClass"><code>BrowsePathsClass</code></a>]</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="get_config">get_config()<a href="#get_config" class="hash-link" aria-label="Direct link to get_config()" title="Direct link to get_config()"></a></h4><ul><li><strong>Return type:</strong><code>Dict</code>[<code>str</code>, <code>Any</code>]</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="get_connection_jsonurn">get_connection_json(urn)<a href="#get_connection_jsonurn" class="hash-link" aria-label="Direct link to get_connection_json(urn)" title="Direct link to get_connection_json(urn)"></a></h4><p>Retrieve a connection config.</p><p>This is only supported with DataHub Cloud.</p><ul><li><strong>Parameters:</strong><strong>urn</strong> (<code>str</code>) – The urn of the connection.</li><li><strong>Return type:</strong><code>Optional</code>[<code>dict</code>]</li><li><strong>Returns:</strong>
|
|||
|
|
The connection config as a dictionary, or None if the connection was not found.</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="get_container_urns_by_filterenvnone-search_query">get_container_urns_by_filter(env=None, search_query='<!-- -->*<!-- -->')<a href="#get_container_urns_by_filterenvnone-search_query" class="hash-link" aria-label="Direct link to get_container_urns_by_filterenvnone-search_query" title="Direct link to get_container_urns_by_filterenvnone-search_query"></a></h4><p>Return container urns that match based on query</p><ul><li><strong>Parameters:</strong><ul><li><strong>env</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li><li><strong>search_query</strong> (<code>str</code>)</li></ul></li><li><strong>Return type:</strong><code>Iterable</code>[<code>str</code>]</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="get_dataset_propertiesentity_urn">get_dataset_properties(entity_urn)<a href="#get_dataset_propertiesentity_urn" class="hash-link" aria-label="Direct link to get_dataset_properties(entity_urn)" title="Direct link to get_dataset_properties(entity_urn)"></a></h4><ul><li><strong>Parameters:</strong><strong>entity_urn</strong> (<code>str</code>)</li><li><strong>Return type:</strong><code>Optional</code>[<a href="/docs/python-sdk/models#datahub.metadata.schema_classes.DatasetPropertiesClass"><code>DatasetPropertiesClass</code></a>]</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="get_domainentity_urn">get_domain(entity_urn)<a href="#get_domainentity_urn" class="hash-link" aria-label="Direct link to get_domain(entity_urn)" title="Direct link to get_domain(entity_urn)"></a></h4><ul><li><strong>Parameters:</strong><strong>entity_urn</strong> (<code>str</code>)</li><li><strong>Return type:</strong><code>Optional</code>[<a href="/docs/python-sdk/models#datahub.metadata.schema_classes.DomainsClass"><code>DomainsClass</code></a>]</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="get_domain_propertiesentity_urn">get_domain_properties(entity_urn)<a href="#get_domain_propertiesentity_urn" class="hash-link" aria-label="Direct link to get_domain_properties(entity_urn)" title="Direct link to get_domain_properties(entity_urn)"></a></h4><ul><li><strong>Parameters:</strong><strong>entity_urn</strong> (<code>str</code>)</li><li><strong>Return type:</strong><code>Optional</code>[<a href="/docs/python-sdk/models#datahub.metadata.schema_classes.DomainPropertiesClass"><code>DomainPropertiesClass</code></a>]</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="get_domain_urn_by_namedomain_name">get_domain_urn_by_name(domain_name)<a href="#get_domain_urn_by_namedomain_name" class="hash-link" aria-label="Direct link to get_domain_urn_by_name(domain_name)" title="Direct link to get_domain_urn_by_name(domain_name)"></a></h4><p>Retrieve a domain urn based on its name. Returns None if there is no match found</p><ul><li><strong>Parameters:</strong><strong>domain_name</strong> (<code>str</code>)</li><li><strong>Return type:</strong><code>Optional</code>[<code>str</code>]</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="get_entitiesentity_name-urns-aspectsnone-with_system_metadatafalse">get_entities(entity_name, urns, aspects=None, with_system_metadata=False)<a href="#get_entitiesentity_name-urns-aspectsnone-with_system_metadatafalse" class="hash-link" aria-label="Direct link to get_entities(entity_name, urns, aspects=None, with_system_metadata=False)" title="Direct link to get_entities(entity_name, urns, aspects=None, with_system_metadata=False)"></a></h4><p>Get entities using the OpenAPI v3 endpoint, deserializing aspects into typed objects.</p><ul><li><strong>Parameters:</strong><ul><li><strong>entity_name</strong> (<code>str</code>) – The entity type name</li><li><strong>urns</strong> (<code>List</code>[<code>str</code>]<!-- -->) – List of entity URNs to fetch</li><li><strong>aspects</strong> (<code>Optional</code>[<code>List</code>[<code>str</code>]<!-- -->]) – Optional list of aspect names to fetch. If None, all aspects will
|
|||
|
|
A dictionary mapping URNs to a dictionary of aspect name to tuples of
|
|||
|
|
(typed aspect object, system metadata). If with_system_metadata is False,
|
|||
|
|
the system metadata in the tuple will be None.</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="get_entities_v2entity_name-urns-aspectsnone-with_system_metadatafalse">get_entities_v2(entity_name, urns, aspects=None, with_system_metadata=False)<a href="#get_entities_v2entity_name-urns-aspectsnone-with_system_metadatafalse" class="hash-link" aria-label="Direct link to get_entities_v2(entity_name, urns, aspects=None, with_system_metadata=False)" title="Direct link to get_entities_v2(entity_name, urns, aspects=None, with_system_metadata=False)"></a></h4><ul><li><strong>Parameters:</strong><ul><li><strong>entity_name</strong> (<code>str</code>)</li><li><strong>urns</strong> (<code>List</code>[<code>str</code>]<!-- -->)</li><li><strong>aspects</strong> (<code>Optional</code>[<code>List</code>[<code>str</code>]<!-- -->])</li><li><strong>with_system_metadata</strong> (<code>bool</code>)</li></ul></li><li><strong>Return type:</strong><code>Dict</code>[<code>str</code>, <code>Any</code>]</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="get_entity_as_mcpsentity_urn-aspectsnone">get_entity_as_mcps(entity_urn, aspects=None)<a href="#get_entity_as_mcpsentity_urn-aspectsnone" class="hash-link" aria-label="Direct link to get_entity_as_mcps(entity_urn, aspects=None)" title="Direct link to get_entity_as_mcps(entity_urn, aspects=None)"></a></h4><p>Get all non-timeseries aspects for an entity.</p><p>By formatting the entity’s aspects as MCPWs, we can also include SystemMetadata.</p><p>Warning: Do not use this method to determine if an entity exists! This method will always return
|
|||
|
|
something, even if the entity doesn’t actually exist in DataHub.</p><ul><li><strong>Parameters:</strong><ul><li><strong>entity_urn</strong> (<code>str</code>) – The urn of the entity</li><li><strong>aspects</strong> (<code>Optional</code>[<code>List</code>[<code>str</code>]<!-- -->]) – Optional list of aspect names being requested (e.g. <!-- -->[“schemaMetadata”, “datasetProperties”]<!-- -->)</li></ul></li><li><strong>Return type:</strong><code>List</code>[<a href="/docs/python-sdk/builder/mcp-builder#datahub.emitter.mcp.MetadataChangeProposalWrapper"><code>MetadataChangeProposalWrapper</code></a>]</li><li><strong>Returns:</strong>
|
|||
|
|
A list of MCPWs.</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="get_entity_rawentity_urn-aspectsnone">get_entity_raw(entity_urn, aspects=None)<a href="#get_entity_rawentity_urn-aspectsnone" class="hash-link" aria-label="Direct link to get_entity_raw(entity_urn, aspects=None)" title="Direct link to get_entity_raw(entity_urn, aspects=None)"></a></h4><ul><li><strong>Parameters:</strong><ul><li><strong>entity_urn</strong> (<code>str</code>)</li><li><strong>aspects</strong> (<code>Optional</code>[<code>List</code>[<code>str</code>]<!-- -->])</li></ul></li><li><strong>Return type:</strong><code>Dict</code></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="get_entity_semitypedentity_urn-aspectsnone">get_entity_semityped(entity_urn, aspects=None)<a href="#get_entity_semitypedentity_urn-aspectsnone" class="hash-link" aria-label="Direct link to get_entity_semityped(entity_urn, aspects=None)" title="Direct link to get_entity_semityped(entity_urn, aspects=None)"></a></h4><p>Get (all) non-timeseries aspects for an entity.</p><p>This method is called “semityped” because it returns aspects as a dictionary of
|
|||
|
|
properly typed objects. While the returned dictionary is constrained using a TypedDict,
|
|||
|
|
the return type is still fairly loose.</p><p>Warning: Do not use this method to determine if an entity exists! This method will always return
|
|||
|
|
something, even if the entity doesn’t actually exist in DataHub.</p><ul><li><strong>Parameters:</strong><ul><li><strong>entity_urn</strong> (<code>str</code>) – The urn of the entity</li><li><strong>aspects</strong> (<code>Optional</code>[<code>List</code>[<code>str</code>]<!-- -->]) – Optional list of aspect names being requested (e.g. <!-- -->[“schemaMetadata”, “datasetProperties”]<!-- -->)</li></ul></li><li><strong>Return type:</strong><a href="/docs/python-sdk/models#datahub.metadata.schema_classes.AspectBag"><code>AspectBag</code></a></li><li><strong>Returns:</strong>
|
|||
|
|
A dictionary of aspect name to aspect value. If an aspect is not found, it will
|
|||
|
|
not be present in the dictionary. The entity’s key aspect will always be present.</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="get_glossary_termsentity_urn">get_glossary_terms(entity_urn)<a href="#get_glossary_termsentity_urn" class="hash-link" aria-label="Direct link to get_glossary_terms(entity_urn)" title="Direct link to get_glossary_terms(entity_urn)"></a></h4><ul><li><strong>Parameters:</strong><strong>entity_urn</strong> (<code>str</code>)</li><li><strong>Return type:</strong><code>Optional</code>[<a href="/docs/python-sdk/models#datahub.metadata.schema_classes.GlossaryTermsClass"><code>GlossaryTermsClass</code></a>]</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="get_kafka_consumer_offsets">get_kafka_consumer_offsets()<a href="#get_kafka_consumer_offsets" class="hash-link" aria-label="Direct link to get_kafka_consumer_offsets()" title="Direct link to get_kafka_consumer_offsets()"></a></h4><p>Get Kafka consumer offsets from the DataHub API.</p><ul><li><strong>Parameters:</strong><strong>graph</strong> (<a href="#datahub.ingestion.graph.client.DataHubGraph"><em>DataHubGraph</em></a>) – The DataHub graph client</li><li><strong>Return type:</strong><code>dict</code></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="get_latest_pipeline_checkpointpipeline_name-platform">get_latest_pipeline_checkpoint(pipeline_name, platform)<a href="#get_latest_pipeline_checkpointpipeline_name-platform" class="hash-link" aria-label="Direct link to get_latest_pipeline_checkpoint(pipeline_name, platform)" title="Direct link to get_latest_pipeline_checkpoint(pipeline_name, platform)"></a></h4><ul><li><strong>Parameters:</strong><ul><li><strong>pipeline_name</strong> (<code>str</code>)</li><li><strong>platform</strong> (<code>str</code>)</li></ul></li><li><strong>Return type:</strong><code>Optional</code>[<code>Checkpoint</code>[<code>GenericCheckpointState</code>]<!-- -->]</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="get_latest_timeseries_valueentity_urn-aspect_type-filter_criteria_map">get_latest_timeseries_value(entity_urn, aspect_type, filter_criteria_map)<a href="#get_latest_timeseries_valueentity_urn-aspect_type-filter_criteria_map" class="hash-link" aria-label="Direct link to get_latest_timeseries_value(entity_urn, aspect_type, filter_criteria_map)" title="Direct link to get_latest_timeseries_value(entity_urn, aspect_type, filter_criteria_map)"></a></h4><ul><li><strong>Parameters:</strong><ul><li><strong>entity_urn</strong> (<code>str</code>)</li><li><strong>aspect_type</strong> (<code>Type</code>[<code>TypeVar</code>(<code>Aspect</code>, bound= <code>_Aspect</code>)]<!-- -->) – </li><li><strong>filter_criteria_map</strong> (<code>Dict</code>[<code>str</code>, <code>str</code>]<!-- -->)</li></ul></li><li><strong>Return type:</strong><code>Optional</code>[<code>TypeVar</code>(<code>Aspect</code>, bound= <code>_Aspect</code>)]</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="get_ownershipentity_urn">get_ownership(entity_urn)<a href="#get_ownershipentity_urn" class="hash-link" aria-label="Direct link to get_ownership(entity_urn)" title="Direct link to get_ownership(entity_urn)"></a></h4><ul><li><strong>Parameters:</strong><strong>entity_urn</strong> (<code>str</code>)</li><li><strong>Return type:</strong><code>Optional</code>[<a href="/docs/python-sdk/models#datahub.metadata.schema_classes.OwnershipClass"><code>OwnershipClass</code></a>]</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="get_related_entitiesentity_urn-relationship_types-direction">get_related_entities(entity_urn, relationship_types, direction)<a href="#get_related_entitiesentity_urn-relationship_types-direction" class="hash-link" aria-label="Direct link to get_related_entities(entity_urn, relationship_types, direction)" title="Direct link to get_related_entities(entity_urn, relationship_types, direction)"></a></h4><ul><li><strong>Parameters:</strong><ul><li><strong>entity_urn</strong> (<code>str</code>)</li><li><strong>relationship_types</strong> (<code>List</code>[<code>str
|
|||
|
|
Note that specifying a platform filter will automatically exclude all entity types that do not have a platform.
|
|||
|
|
The same goes for the env filter.</p><ul><li><strong>Parameters:</strong><ul><li><strong>entity_types</strong> (<code>Optional</code>[<code>List</code>[<code>str</code>]<!-- -->]) – List of entity types to include. If None, all entity types will be returned.</li><li><strong>platform</strong> (<code>Optional</code>[<code>str</code>]<!-- -->) – Platform to filter on. If None, all platforms will be returned.</li><li><strong>platform_instance</strong> (<code>Optional</code>[<code>str</code>]<!-- -->) – Platform instance to filter on. If None, all platform instances will be returned.</li><li><strong>env</strong> (<code>Optional</code>[<code>str</code>]<!-- -->) – Environment (e.g. PROD, DEV) to filter on. If None, all environments will be returned.</li><li><strong>query</strong> (<code>Optional</code>[<code>str</code>]<!-- -->) – Query string to filter on. If None, all entities will be returned.</li><li><strong>container</strong> (<code>Optional</code>[<code>str</code>]<!-- -->) – A container urn that entities must be within.
|
|||
|
|
This works recursively, so it will include entities within sub-containers as well.
|
|||
|
|
If None, all entities will be returned.
|
|||
|
|
Note that this requires browsePathV2 aspects (added in 0.10.4+).</li><li><strong>status</strong> (<code>RemovedStatusFilter</code>) – Filter on the deletion status of the entity. The default is only return non-soft-deleted entities.</li><li><strong>extra_and_filters</strong> (<code>Optional</code>[<code>List</code>[<code>Dict</code>[<code>str</code>, <code>Union</code>[<code>str</code>, <code>bool</code>, <code>List</code>[<code>str</code>]<!-- -->]]]]) – Additional filters to apply. If specified, the
|
|||
|
|
results will match all of the filters.</li><li><strong>extra_or_filters</strong> (<code>Optional</code>[<code>List</code>[<code>Dict</code>[<code>Literal</code>[<code>'and'</code>]<!-- -->, <code>List</code>[<code>Dict</code>[<code>str</code>, <code>Union</code>[<code>str</code>, <code>bool</code>, <code>List</code>[<code>str</code>]<!-- -->]]]]]]) – Additional filters to apply. If specified, the
|
|||
|
|
results will match any of the filters.</li><li><strong>batch_size</strong> (<code>int</code>)</li><li><strong>extra_source_fields</strong> (<code>Optional</code>[<code>List</code>[<code>str</code>]<!-- -->])</li><li><strong>skip_cache</strong> (<code>bool</code>)</li></ul></li><li><strong>Return type:</strong><code>Iterable</code>[<code>dict</code>]</li><li><strong>Returns:</strong>
|
|||
|
|
An iterable of urns that match the filters.</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="get_schema_metadataentity_urn">get_schema_metadata(entity_urn)<a href="#get_schema_metadataentity_urn" class="hash-link" aria-label="Direct link to get_schema_metadata(entity_urn)" title="Direct link to get_schema_metadata(entity_urn)"></a></h4><ul><li><strong>Parameters:</strong><strong>entity_urn</strong> (<code>str</code>)</li><li><strong>Return type:</strong><code>Optional</code>[<a href="/docs/python-sdk/models#datahub.metadata.schema_classes.SchemaMetadataClass"><code>SchemaMetadataClass</code></a>]</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="get_search_resultsstart0-count1-entitydataset">get_search_results(start=0, count=1, entity='dataset')<a href="#get_search_resultsstart0-count1-entitydataset" class="hash-link" aria-label="Direct link to get_search_results(start=0, count=1, entity='dataset')" title="Direct link to get_search_results(start=0, count=1, entity='dataset')"></a></h4><ul><li><strong>Parameters:</strong><ul><li><strong>start</strong> (<code>int</code>)</li><li><strong>count</strong> (<code>int</code>)</li><li><strong>entity</strong> (<code>str</code>)</li></ul></li><li><strong>Return type:</strong><code>Dict</code></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="get_tagsentity_urn">get_tags(entity_urn)<a href="#get_tagsentity_urn" class="hash-link" aria-label="Direct link to get_tags(entity_urn)" title="Direct link to get_tags(entity_urn)"></a></h4><ul><li><strong>Parameters:</strong><strong>entity_urn</strong> (<code>str</code>)</li><li><strong>Return type:</strong><code>Optional</code>[<a href="/docs/python-sdk/models#datahub.metadata.schema_classes.GlobalTagsClass"><code>GlobalTagsClass</code></a>]</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="get_timeseries_valuesentity_urn-aspect_type-filter-limit10">get_timeseries_values(entity_urn, aspect_type, filter, limit=10)<a href="#get_timeseries_valuesentity_urn-aspect_type-filter-limit10" class="hash-link" aria-label="Direct link to get_timeseries_values(entity_urn, aspect_type, filter, limit=10)" title="Direct link to get_timeseries_values(entity_urn, aspect_type, filter, limit=10)"></a></h4><ul><li><strong>Parameters:</strong><ul><li><strong>entity_urn</strong> (<code>str</code>)</li><li><strong>aspect_type</strong> (<code>Type</code>[<code>TypeVar</code>(<code>Aspect</code>, bound= <code>_Aspect</code>)]<!-- -->) – </li><li><strong>filter</strong> (<code>Dict</code>[<code>str</code>, <code>Any</code>]<!-- -->)</li><li><strong>limit</strong> (<code>int</code>)</li></ul></li><li><strong>Return type:</strong><code>List</code>[<code>TypeVar</code>(<code>Aspect</code>, bound= <code>_Aspect</code>)]</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="get_urns_by_filter-entity_typesnone-platformnone-platform_instancenone-envnone-querynone-containernone-statusremovedstatusfilternot_soft_deleted-batch_size5000-extrafiltersnone-extra_or_filtersnone-skip_cachefalse">get_urns_by_filter(<!-- -->*<!-- -->, entity_types=None, platform=None, platform_instance=None, env=None, query=None, container=None, status=RemovedStatusFilter.NOT_SOFT_DELETED, batch_size=5000, extraFilters=None, extra_or_filters=None, skip_cache=False)<a href="#get_urns_by_filter-entity_typesnone-platformnone-platform_instancenone-envnone-querynone-containernone-statusremovedstatusfilternot_soft_deleted-batch_size5000-extrafiltersnone-extra_or_filtersnone-skip_cachefalse" class="hash-link" aria-label="Direct link to get_urns_by_filter-entity_typesnone-platformnone-platform_instancenone-envnone-querynone-containernone-statusremovedstatusfilternot_soft_deleted-batch_size5000-extrafiltersnone-extra_or_filtersnone-skip_cachefalse" title="Direct link to get_urns_by_filter-entity_typesnone-platformnone-platform_instancenone-envnone-querynone-containernone-statusremovedstatusfilternot_soft_deleted-batch_size5000-extrafiltersnone-extra_or_filtersnone-skip_cachefalse"></a></h4><p>Fetch all urns that match a
|
|||
|
|
Note that specifying a platform filter will automatically exclude all entity types that do not have a platform.
|
|||
|
|
The same goes for the env filter.</p><ul><li><strong>Parameters:</strong><ul><li><strong>entity_types</strong> (<code>Optional</code>[<code>Sequence</code>[<code>str</code>]<!-- -->]) – List of entity types to include. If None, all entity types will be returned.</li><li><strong>platform</strong> (<code>Optional</code>[<code>str</code>]<!-- -->) – Platform to filter on. If None, all platforms will be returned.</li><li><strong>platform_instance</strong> (<code>Optional</code>[<code>str</code>]<!-- -->) – Platform instance to filter on. If None, all platform instances will be returned.</li><li><strong>env</strong> (<code>Optional</code>[<code>str</code>]<!-- -->) – Environment (e.g. PROD, DEV) to filter on. If None, all environments will be returned.</li><li><strong>query</strong> (<code>Optional</code>[<code>str</code>]<!-- -->) – Query string to filter on. If None, all entities will be returned.</li><li><strong>container</strong> (<code>Optional</code>[<code>str</code>]<!-- -->) – A container urn that entities must be within.
|
|||
|
|
This works recursively, so it will include entities within sub-containers as well.
|
|||
|
|
If None, all entities will be returned.
|
|||
|
|
Note that this requires browsePathV2 aspects (added in 0.10.4+).</li><li><strong>status</strong> (<code>Optional</code>[<code>RemovedStatusFilter</code>]<!-- -->) – Filter on the deletion status of the entity. The default is only return non-soft-deleted entities.</li><li><strong>extraFilters</strong> (<code>Optional</code>[<code>List</code>[<code>Dict</code>[<code>str</code>, <code>Union</code>[<code>str</code>, <code>bool</code>, <code>List</code>[<code>str</code>]<!-- -->]]]]) – Additional filters to apply. If specified, the results will match all of the filters.</li><li><strong>skip_cache</strong> (<code>bool</code>) – Whether to bypass caching. Defaults to False.</li><li><strong>batch_size</strong> (<code>int</code>)</li><li><strong>extra_or_filters</strong> (<code>Optional</code>[<code>List</code>[<code>Dict</code>[<code>Literal</code>[<code>'and'</code>]<!-- -->, <code>List</code>[<code>Dict</code>[<code>str</code>, <code>Union</code>[<code>str</code>, <code>bool</code>, <code>List</code>[<code>str</code>]<!-- -->]]]]]])</li></ul></li><li><strong>Return type:</strong><code>Iterable</code>[<code>str</code>]</li><li><strong>Returns:</strong>
|
|||
|
|
An iterable of urns that match the filters.</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="get_usage_aspects_from_urnentity_urn-start_timestamp-end_timestamp">get_usage_aspects_from_urn(entity_urn, start_timestamp, end_timestamp)<a href="#get_usage_aspects_from_urnentity_urn-start_timestamp-end_timestamp" class="hash-link" aria-label="Direct link to get_usage_aspects_from_urn(entity_urn, start_timestamp, end_timestamp)" title="Direct link to get_usage_aspects_from_urn(entity_urn, start_timestamp, end_timestamp)"></a></h4><ul><li><strong>Parameters:</strong><ul><li><strong>entity_urn</strong> (<code>str</code>)</li><li><strong>start_timestamp</strong> (<code>int</code>)</li><li><strong>end_timestamp</strong> (<code>int</code>)</li></ul></li><li><strong>Return type:</strong><code>Optional</code>[<code>List</code>[<a href="/docs/python-sdk/models#datahub.metadata.schema_classes.DatasetUsageStatisticsClass"><code>DatasetUsageStatisticsClass</code></a>]]</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="hard_delete_entityurn">hard_delete_entity(urn)<a href="#hard_delete_entityurn" class="hash-link" aria-label="Direct link to hard_delete_entity(urn)" title="Direct link to hard_delete_entity(urn)"></a></h4><p>Hard delete an entity by urn.</p><ul><li><strong>Parameters:</strong><strong>urn</strong> (<code>str</code>) – The urn of the entity to hard delete.</li><li><strong>Return type:</strong><code>Tuple</code>[<code>int</code>, <code>int</code>]</li><li><strong>Returns:</strong>
|
|||
|
|
A tuple of (rows_affected, timeseries_rows_affected).</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="hard_delete_timeseries_aspecturn-aspect_name-start_time-end_time">hard_delete_timeseries_aspect(urn, aspect_name, start_time, end_time)<a href="#hard_delete_timeseries_aspecturn-aspect_name-start_time-end_time" class="hash-link" aria-label="Direct link to hard_delete_timeseries_aspect(urn, aspect_name, start_time, end_time)" title="Direct link to hard_delete_timeseries_aspect(urn, aspect_name, start_time, end_time)"></a></h4><p>Hard delete timeseries aspects of an entity.</p><ul><li><strong>Parameters:</strong><ul><li><strong>urn</strong> (<code>str</code>) – The urn of the entity.</li><li><strong>aspect_name</strong> (<code>str</code>) – The name of the timeseries aspect to delete.</li><li><strong>start_time</strong> (<code>Optional</code>[<code>datetime</code>]<!-- -->) – The start time of the timeseries data to delete. If not specified, defaults to the beginning of time.</li><li><strong>end_time</strong> (<code>Optional</code>[<code>datetime</code>]<!-- -->) – The end time of the timeseries data to delete. If not specified, defaults to the end of time.</li></ul></li><li><strong>Return type:</strong><code>int</code></li><li><strong>Returns:</strong>
|
|||
|
|
The number of timeseries rows affected.</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="initialize_schema_resolver_from_datahubplatform-platform_instance-env-batch_size100">initialize_schema_resolver_from_datahub(platform, platform_instance, env, batch_size=100)<a href="#initialize_schema_resolver_from_datahubplatform-platform_instance-env-batch_size100" class="hash-link" aria-label="Direct link to initialize_schema_resolver_from_datahub(platform, platform_instance, env, batch_size=100)" title="Direct link to initialize_schema_resolver_from_datahub(platform, platform_instance, env, batch_size=100)"></a></h4><ul><li><strong>Parameters:</strong><ul><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>batch_size</strong> (<code>int</code>)</li></ul></li><li><strong>Return type:</strong><code>SchemaResolver</code></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="list_all_entity_urnsentity_type-start-count">list_all_entity_urns(entity_type, start, count)<a href="#list_all_entity_urnsentity_type-start-count" class="hash-link" aria-label="Direct link to list_all_entity_urns(entity_type, start, count)" title="Direct link to list_all_entity_urns(entity_type, start, count)"></a></h4><ul><li><strong>Parameters:</strong><ul><li><strong>entity_type</strong> (<code>str</code>)</li><li><strong>start</strong> (<code>int</code>)</li><li><strong>count</strong> (<code>int</code>)</li></ul></li><li><strong>Return type:</strong><code>Optional</code>[<code>List</code>[<code>str</code>]<!-- -->]</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="makerest_sinkrun_id_datahub-graph-client-extra_sink_confignone">make<em>rest_sink(run_id='</em>_<!-- -->datahub-graph-client', extra_sink_config=None)<a href="#makerest_sinkrun_id_datahub-graph-client-extra_sink_confignone" class="hash-link" aria-label="Direct link to makerest_sinkrun_id_datahub-graph-client-extra_sink_confignone" title="Direct link to makerest_sinkrun_id_datahub-graph-client-extra_sink_confignone"></a></h4><ul><li><strong>Parameters:</strong><ul><li><strong>run_id</strong> (<code>str</code>)</li><li><strong>extra_sink_config</strong> (<code>Optional</code>[<code>Dict</code>]<!-- -->)</li></ul></li><li><strong>Return type:</strong><code>Iterator</code>[<code>DatahubRestSink</code>]</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="parse_sql_lineagesql--platform-platform_instancenone-envprod-default_dbnone-default_schemanone-default_dialectnone">parse_sql_lineage(sql, <!-- -->*<!-- -->, platform, platform_instance=None, env='PROD', default_db=None, default_schema=None, default_dialect=None)<a href="#parse_sql_lineagesql--platform-platform_instancenone-envprod-default_dbnone-default_schemanone-default_dialectnone" class="hash-link" aria-label="Direct link to parse_sql_lineagesql--platform-platform_instancenone-envprod-default_dbnone-default_schemanone-default_dialectnone" title="Direct link to parse_sql_lineagesql--platform-platform_instancenone-envprod-default_dbnone-default_schemanone-default_dialectnone"></a></h4><ul><li><strong>Parameters:</strong><ul><li><strong>sql</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>default_dialect</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li></ul></li><li><strong>Return type:</strong><code>SqlParsingResult</code></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="remove_tagtag_urn-resource_urn">remove_tag(tag_urn, resource_urn)<a href="#remove_tagtag_urn-resource_urn" class="hash-link" aria-label="Direct link to remove_tag(tag_urn, resource_u
|
|||
|
|
A string containing the result of the restore indices operation. This format is subject to change.</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="run_assertionurn-save_resulttrue-parametersnone-async_flagfalse">run_assertion(urn, save_result=True, parameters=None, async_flag=False)<a href="#run_assertionurn-save_resulttrue-parametersnone-async_flagfalse" class="hash-link" aria-label="Direct link to run_assertion(urn, save_result=True, parameters=None, async_flag=False)" title="Direct link to run_assertion(urn, save_result=True, parameters=None, async_flag=False)"></a></h4><ul><li><strong>Parameters:</strong><ul><li><strong>urn</strong> (<code>str</code>)</li><li><strong>save_result</strong> (<code>bool</code>)</li><li><strong>parameters</strong> (<code>Optional</code>[<code>Dict</code>[<code>str</code>, <code>str</code>]<!-- -->])</li><li><strong>async_flag</strong> (<code>bool</code>)</li></ul></li><li><strong>Return type:</strong><code>Dict</code></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="run_assertionsurns-save_resulttrue-parametersnone-async_flagfalse">run_assertions(urns, save_result=True, parameters=None, async_flag=False)<a href="#run_assertionsurns-save_resulttrue-parametersnone-async_flagfalse" class="hash-link" aria-label="Direct link to run_assertions(urns, save_result=True, parameters=None, async_flag=False)" title="Direct link to run_assertions(urns, save_result=True, parameters=None, async_flag=False)"></a></h4><ul><li><strong>Parameters:</strong><ul><li><strong>urns</strong> (<code>List</code>[<code>str</code>]<!-- -->)</li><li><strong>save_result</strong> (<code>bool</code>)</li><li><strong>parameters</strong> (<code>Optional</code>[<code>Dict</code>[<code>str</code>, <code>str</code>]<!-- -->])</li><li><strong>async_flag</strong> (<code>bool</code>)</li></ul></li><li><strong>Return type:</strong><code>Dict</code></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="run_assertions_for_asseturn-tag_urnsnone-parametersnone-async_flagfalse">run_assertions_for_asset(urn, tag_urns=None, parameters=None, async_flag=False)<a href="#run_assertions_for_asseturn-tag_urnsnone-parametersnone-async_flagfalse" class="hash-link" aria-label="Direct link to run_assertions_for_asset(urn, tag_urns=None, parameters=None, async_flag=False)" title="Direct link to run_assertions_for_asset(urn, tag_urns=None, parameters=None, async_flag=False)"></a></h4><ul><li><strong>Parameters:</strong><ul><li><strong>urn</strong> (<code>str</code>)</li><li><strong>tag_urns</strong> (<code>Optional</code>[<code>List</code>[<code>str</code>]<!-- -->])</li><li><strong>parameters</strong> (<code>Optional</code>[<code>Dict</code>[<code>str</code>, <code>str</code>]<!-- -->])</li><li><strong>async_flag</strong> (<code>bool</code>)</li></ul></li><li><strong>Return type:</strong><code>Dict</code></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="set_connection_jsonurn--platform_urn-config-namenone">set_connection_json(urn, <!-- -->*<!-- -->, platform_urn, config, name=None)<a href="#set_connection_jsonurn--platform_urn-config-namenone" class="hash-link" aria-label="Direct link to set_connection_jsonurn--platform_urn-config-namenone" title="Direct link to set_connection_jsonurn--platform_urn-config-namenone"></a></h4><p>Set a connection config.</p><p>This is only supported with DataHub Cloud.</p><ul><li><strong>Parameters:</strong><ul><li><strong>urn</strong> (<code>str</code>) – The urn of the connection.</li><li><strong>platform_urn</strong> (<code>str</code>) – The urn of the platform.</li><li><strong>config</strong> (<code>Union</code>[<code>ConfigModel</code>, <code>BaseModel</code>, <code>dict</code>]<!-- -->) – The connection config as a dictionary or a ConfigModel.</li><li><strong>name</strong> (<code>Optional</code>[<code>str</code>]<!-- -->) – The name of the connection.</li></ul></li><li><strong>Return type:</strong><code>None</code></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="setsoft_delete_statusurn-delete-run_id_datahub-graph-client-deletion_timestampno
|
|||
|
|
The public-facing url for the entity.</li></ul></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.ingestion.graph.client.RelatedEntity"><span class="visually-hidden">RelatedEntity</span><a href="#datahub.ingestion.graph.client.RelatedEntity" class="hash-link" aria-label="Direct link to datahub.ingestion.graph.client.RelatedEntity" title="Direct link to datahub.ingestion.graph.client.RelatedEntity"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-text">class</span> <span class="class-owner">datahub.ingestion.graph.client.</span><span class="class-name">RelatedEntity</span>(<span class="arg-name">urn</span>, <span class="arg-name">relationship_type</span>, <span class="arg-name">via</span> = <span class="arg-default">None</span>)<a href="#datahub.ingestion.graph.client.RelatedEntity" 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>relationship_type</strong> (<code>str</code>)</li><li><strong>via</strong> (<code>Optional</code>[<code>str</code>]<!-- -->)</li></ul></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="relationship_type--str">relationship_type <em>: <code>str</code></em><a href="#relationship_type--str" class="hash-link" aria-label="Direct link to relationship_type--str" title="Direct link to relationship_type--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><h4 class="anchor anchorWithStickyNavbar_LWe7" id="via--optionalstr--none">via <em>: <code>Optional</code>[<code>str</code>]</em> <em>= None</em><a href="#via--optionalstr--none" class="hash-link" aria-label="Direct link to via--optionalstr--none" title="Direct link to via--optionalstr--none"></a></h4></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.ingestion.graph.client.entity_type_to_graphql"><span class="visually-hidden">entity_type_to_graphql</span><a href="#datahub.ingestion.graph.client.entity_type_to_graphql" class="hash-link" aria-label="Direct link to datahub.ingestion.graph.client.entity_type_to_graphql" title="Direct link to datahub.ingestion.graph.client.entity_type_to_graphql"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-owner">datahub.ingestion.graph.client.</span><span class="class-name">entity_type_to_graphql</span>(<span class="arg-name">entity_type</span>)<a href="#datahub.ingestion.graph.client.entity_type_to_graphql" class="hash-link"></a></div><p>Convert the entity types into GraphQL “EntityType” enum values.</p><ul><li><strong>Parameters:</strong><strong>entity_type</strong> (<code>str</code>)</li><li><strong>Return type:</strong><code>str</code></li></ul></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.ingestion.graph.client.flexible_entity_type_to_graphql"><span class="visually-hidden">flexible_entity_type_to_graphql</span><a href="#datahub.ingestion.graph.client.flexible_entity_type_to_graphql" class="hash-link" aria-label="Direct link to datahub.ingestion.graph.client.flexible_entity_type_to_graphql" title="Direct link to datahub.ingestion.graph.client.flexible_entity_type_to_graphql"></a></h3><div class="h3-block"><div class="section-heading"><span class="class-owner">datahub.ingestion.graph.client.</span><span class="class-name">flexible_entity_type_to_graphql</span>(<span class="arg-name">entity_type</span>)<a href="#datahub.ingestion.graph.client.flexible_entity_type_to_graphql" class="hash-link"></a></div><ul><li><strong>Parameters:</strong><strong>entity_type</strong> (<code>str</code>)</li><li><strong>Return type:</strong><code>str</code></li></ul></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datahub.ingestion.graph.client.get_default_graph"><span class="visually-hidden">get_default_graph</span><a href="#datahub.ingestion.graph.client.get_default_graph" class="hash-link" aria-label="Direct lin
|
|||
|
|
<script src="/assets/js/runtime~main.83fcf86b.js"></script>
|
|||
|
|
<script src="/assets/js/main.bc908355.js"></script>
|
|||
|
|
</body>
|
|||
|
|
</html>
|