yujunjun/datahub
2
0
Fork 0
mirror of https://github.com/datahub-project/datahub.git synced 2025-07-04 15:50:14 +00:00
Code Issues Packages Projects Releases Wiki Activity
datahub/docs/graphql/enums/index.html

118 lines
127 KiB
HTML
Raw Permalink Normal View History

deploy: 308c6bd28ea47ddaf6fdc18853c8540805f43ced
2025-07-04 15:30:07 +00:00
<!doctype html>
<html lang="en" dir="ltr" class="docs-wrapper docs-doc-page docs-version-current plugin-docs plugin-id-default docs-doc-id-graphql/enums" data-has-hydrated="false">
<head>
<meta charset="UTF-8">
<meta name="generator" content="Docusaurus v2.4.3">
<title data-rh="true">Enums | 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/graphql/enums"><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="Enums | DataHub"><meta data-rh="true" name="description" content="AccessLevel"><meta data-rh="true" property="og:description" content="AccessLevel"><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://docs.datahub.com/docs/graphql/enums"><link data-rh="true" rel="alternate" href="https://docs.datahub.com/docs/graphql/enums" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.datahub.com/docs/graphql/enums" 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 &#39;self&#39; 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.a760fe73.js" as="script">
<link rel="preload" href="/assets/js/main.a5ea2da0.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/graphql/enums">Next</a></li><li><a class="dropdown__link" href="/docs/1.1.0/graphql/enums">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&amp;utm_medium=header&amp;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 &#x27;What Is DataHub?&#x27;" 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 &#x27;Features&#x27;" 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
The type of an edge between two Datasets</p><p style="margin-bottom:0.4em"><strong>Values</strong></p><table><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td>COPY</td><td><p>Direct copy without modification</p></td></tr><tr><td>TRANSFORMED</td><td><p>Transformed dataset</p></td></tr><tr><td>VIEW</td><td><p>Represents a view defined on the sources</p></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="dateinterval">DateInterval<a href="#dateinterval" class="hash-link" aria-label="Direct link to DateInterval" title="Direct link to DateInterval">​</a></h2><p>For consumption by UI only</p><p style="margin-bottom:0.4em"><strong>Values</strong></p><table><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td>SECOND</td><td></td></tr><tr><td>MINUTE</td><td></td></tr><tr><td>HOUR</td><td></td></tr><tr><td>DAY</td><td></td></tr><tr><td>WEEK</td><td></td></tr><tr><td>MONTH</td><td></td></tr><tr><td>YEAR</td><td></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="entitytype">EntityType<a href="#entitytype" class="hash-link" aria-label="Direct link to EntityType" title="Direct link to EntityType">​</a></h2><p>A top level Metadata Entity Type</p><p style="margin-bottom:0.4em"><strong>Values</strong></p><table><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td>DOMAIN</td><td><p>A Domain containing Metadata Entities</p></td></tr><tr><td>DATASET</td><td><p>The Dataset Entity</p></td></tr><tr><td>CORP_USER</td><td><p>The CorpUser Entity</p></td></tr><tr><td>CORP_GROUP</td><td><p>The CorpGroup Entity</p></td></tr><tr><td>DATA_PLATFORM</td><td><p>The DataPlatform Entity</p></td></tr><tr><td>ER_MODEL_RELATIONSHIP</td><td><p>The ERModelRelationship Entity</p></td></tr><tr><td>DASHBOARD</td><td><p>The Dashboard Entity</p></td></tr><tr><td>NOTEBOOK</td><td><p>The Notebook Entity</p></td></tr><tr><td>CHART</td><td><p>The Chart Entity</p></td></tr><tr><td>DATA_FLOW</td><td><p>The Data Flow (or Data Pipeline) Entity,</p></td></tr><tr><td>DATA_JOB</td><td><p>The Data Job (or Data Task) Entity</p></td></tr><tr><td>TAG</td><td><p>The Tag Entity</p></td></tr><tr><td>GLOSSARY_TERM</td><td><p>The Glossary Term Entity</p></td></tr><tr><td>GLOSSARY_NODE</td><td><p>The Glossary Node Entity</p></td></tr><tr><td>CONTAINER</td><td><p>A container of Metadata Entities</p></td></tr><tr><td>MLMODEL</td><td><p>The ML Model Entity</p></td></tr><tr><td>MLMODEL_GROUP</td><td><p>The MLModelGroup Entity</p></td></tr><tr><td>MLFEATURE_TABLE</td><td><p>ML Feature Table Entity</p></td></tr><tr><td>MLFEATURE</td><td><p>The ML Feature Entity</p></td></tr><tr><td>MLPRIMARY_KEY</td><td><p>The ML Primary Key Entity</p></td></tr><tr><td>INGESTION_SOURCE</td><td><p>A DataHub Managed Ingestion Source</p></td></tr><tr><td>EXECUTION_REQUEST</td><td><p>A DataHub ExecutionRequest</p></td></tr><tr><td>ASSERTION</td><td><p>A DataHub Assertion</p></td></tr><tr><td>DATA_PROCESS_INSTANCE</td><td><p>An instance of an individual run of a data job or data flow</p></td></tr><tr><td>DATA_PLATFORM_INSTANCE</td><td><p>Data Platform Instance Entity</p></td></tr><tr><td>ACCESS_TOKEN</td><td><p>A DataHub Access Token</p></td></tr><tr><td>TEST</td><td><p>A DataHub Test</p></td></tr><tr><td>DATAHUB_POLICY</td><td><p>A DataHub Policy</p></td></tr><tr><td>DATAHUB_ROLE</td><td><p>A DataHub Role</p></td></tr><tr><td>POST</td><td><p>A DataHub Post</p></td></tr><tr><td>SCHEMA_FIELD</td><td><p>A Schema Field</p></td></tr><tr><td>DATAHUB_VIEW</td><td><p>A DataHub View</p></td></tr><tr><td>QUERY</td><td><p>A dataset query</p></td></tr><tr><td>DATA_PRODUCT</td><td><p>A Data Product</p></td></tr><tr><td>CUSTOM_OWNERSHIP_TYPE</td><td><p>A Custom Ownership Type</p></td></tr><tr><td>DATAHUB_CONNECTION</td><td><p>A connection to an external source.</p></td></tr><tr><td>INCIDENT</td><td><p>A DataHub incident - SaaS only</p></td></tr><tr><td>ROLE</td><td><p>&quot; A Role from an organisation</p></td></tr><tr><td>DATA_CONTRACT</td><td><p>A data contract</p></td></tr><tr><td>STRUCTURED_PROPERTY</td><t
Note that this model will soon be deprecated in favor of a more general purpose of notion
of data environment</p><p style="margin-bottom:0.4em"><strong>Values</strong></p><table><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td>DEV</td><td><p>Designates development fabrics</p></td></tr><tr><td>TEST</td><td><p>Designates testing fabrics</p></td></tr><tr><td>QA</td><td><p>Designates quality assurance fabrics</p></td></tr><tr><td>UAT</td><td><p>Designates user acceptance testing fabrics</p></td></tr><tr><td>EI</td><td><p>Designates early integration fabrics</p></td></tr><tr><td>PRE</td><td><p>Designates pre-production fabrics</p></td></tr><tr><td>STG</td><td><p>Designates staging fabrics</p></td></tr><tr><td>NON_PROD</td><td><p>Designates non-production fabrics</p></td></tr><tr><td>PROD</td><td><p>Designates production fabrics</p></td></tr><tr><td>CORP</td><td><p>Designates corporation fabrics</p></td></tr><tr><td>RVW</td><td><p>Designates review fabrics</p></td></tr><tr><td>SANDBOX</td><td><p>Designates sandbox fabrics</p></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="fieldassertiontype">FieldAssertionType<a href="#fieldassertiontype" class="hash-link" aria-label="Direct link to FieldAssertionType" title="Direct link to FieldAssertionType">​</a></h2><p>The type of a Field assertion</p><p style="margin-bottom:0.4em"><strong>Values</strong></p><table><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td>FIELD_VALUES</td><td><p>An assertion used to validate the values contained with a field / column given a set of rows.</p></td></tr><tr><td>FIELD_METRIC</td><td><p>An assertion used to validate the value of a common field / column metric (e.g. aggregation) such as null count + percentage, min, max, median, and more.</p></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="fieldmetrictype">FieldMetricType<a href="#fieldmetrictype" class="hash-link" aria-label="Direct link to FieldMetricType" title="Direct link to FieldMetricType">​</a></h2><p>A standard metric that can be derived from the set of values
for a specific field / column of a dataset / table.</p><p style="margin-bottom:0.4em"><strong>Values</strong></p><table><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td>UNIQUE_COUNT</td><td><p>The number of unique values found in the column value set</p></td></tr><tr><td>UNIQUE_PERCENTAGE</td><td><p>The percentage of unique values to total rows for the dataset</p></td></tr><tr><td>NULL_COUNT</td><td><p>The number of null values found in the column value set</p></td></tr><tr><td>NULL_PERCENTAGE</td><td><p>The percentage of null values to total rows for the dataset</p></td></tr><tr><td>MIN</td><td><p>The minimum value in the column set (applies to numeric columns)</p></td></tr><tr><td>MAX</td><td><p>The maximum value in the column set (applies to numeric columns)</p></td></tr><tr><td>MEAN</td><td><p>The mean length found in the column set (applies to numeric columns)</p></td></tr><tr><td>MEDIAN</td><td><p>The median length found in the column set (applies to numeric columns)</p></td></tr><tr><td>STDDEV</td><td><p>The stddev length found in the column set (applies to numeric columns)</p></td></tr><tr><td>NEGATIVE_COUNT</td><td><p>The number of negative values found in the value set (applies to numeric columns)</p></td></tr><tr><td>NEGATIVE_PERCENTAGE</td><td><p>The percentage of negative values to total rows for the dataset (applies to numeric columns)</p></td></tr><tr><td>ZERO_COUNT</td><td><p>The number of zero values found in the value set (applies to numeric columns)</p></td></tr><tr><td>ZERO_PERCENTAGE</td><td><p>The percentage of zero values to total rows for the dataset (applies to numeric columns)</p></td></tr><tr><td>MIN_LENGTH</td><td><p>The minimum length found in the column set (applies to string columns)</p></td></tr><tr><td>MAX_LENGTH</td><td><p>The maximum length found in the column set (applies to string columns)</p></td></tr><tr><td>EMPTY_COUNT</td><td><p>The number of empty string values found in the value set (applies to string columns). Note: This is a completely different metric different from NULL_COUNT!</p></td></tr><tr><td>EMPTY_PERCENTAGE</td><td><p>The percentage of empty string values to total rows for the dataset (applies to string columns). Note: This is a completely different metric different from NULL_PERCENTAGE!</p></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="fieldtransformtype">FieldTransformType<a href="#fieldtransformtype" class="hash-link" aria-label="Direct link to FieldTransformType" title="Direct link to FieldTransformType">​</a></h2><p>The type of the Field Transform</p><p style="margin-bottom:0.4em"><strong>Values</strong></p><table><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td>LENGTH</td><td><p>Obtain the length of a string field / column (applicable to string types)</p></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="fieldvaluesfailthresholdtype">FieldValuesFailThresholdType<a href="#fieldvaluesfailthresholdtype" class="hash-link" aria-label="Direct link to FieldValuesFailThresholdType" title="Direct link to FieldValuesFailThresholdType">​</a></h2><p>The type of failure threshold.</p><p style="margin-bottom:0.4em"><strong>Values</strong></p><table><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td>COUNT</td><td><p>The maximum number of column values (i.e. rows) that are allowed to fail the defined expectations before the assertion officially fails.</p></td></tr><tr><td>PERCENTAGE</td><td><p>The maximum percentage of rows that are allowed to fail the defined column expectations before the assertion officially fails.</p></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="filteroperator">FilterOperator<a href="#filteroperator" class="hash-link" aria-label="Direct link to FilterOperator" title="Direct link to FilterOperator">​</a></h2><p style="margin-bottom:0.4em"><strong>Values</strong></p><table><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td>CONTAIN</td><td><p>Represent the relation: String fiel
Note that this field will soon become deprecated due to low usage</p><p style="margin-bottom:0.4em"><strong>Values</strong></p><table><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td>TECHNICAL_OWNER</td><td><p>A person or group who is responsible for technical aspects of the asset.</p></td></tr><tr><td>BUSINESS_OWNER</td><td><p>A person or group who is responsible for logical, or business related, aspects of the asset.</p></td></tr><tr><td>DATA_STEWARD</td><td><p>A steward, expert, or delegate responsible for the asset.</p></td></tr><tr><td>NONE</td><td><p>No specific type associated with the owner.</p></td></tr><tr><td>CUSTOM</td><td><p>Associated ownership type is a custom ownership type. Please check OwnershipTypeEntity urn for custom value.</p></td></tr><tr><td>DATAOWNER</td><td><p>A person or group that owns the data. Deprecated! This ownership type is no longer supported. Use TECHNICAL_OWNER instead.</p></td></tr><tr><td>DEVELOPER</td><td><p>A person or group that is in charge of developing the code Deprecated! This ownership type is no longer supported. Use TECHNICAL_OWNER instead.</p></td></tr><tr><td>DELEGATE</td><td><p>A person or a group that overseas the operation, eg a DBA or SRE Deprecated! This ownership type is no longer supported. Use TECHNICAL_OWNER instead.</p></td></tr><tr><td>PRODUCER</td><td><p>A person, group, or service that produces or generates the data Deprecated! This ownership type is no longer supported. Use TECHNICAL_OWNER instead.</p></td></tr><tr><td>STAKEHOLDER</td><td><p>A person or a group that has direct business interest Deprecated! Use BUSINESS_OWNER instead.</p></td></tr><tr><td>CONSUMER</td><td><p>A person, group, or service that consumes the data Deprecated! This ownership type is no longer supported.</p></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="pagemodulescope">PageModuleScope<a href="#pagemodulescope" class="hash-link" aria-label="Direct link to PageModuleScope" title="Direct link to PageModuleScope">​</a></h2><p>Different scopes for where this module is relevant</p><p style="margin-bottom:0.4em"><strong>Values</strong></p><table><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td>PERSONAL</td><td><p>This module is used for individual use only</p></td></tr><tr><td>GLOBAL</td><td><p>This module is used across users</p></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="pagetemplatescope">PageTemplateScope<a href="#pagetemplatescope" class="hash-link" aria-label="Direct link to PageTemplateScope" title="Direct link to PageTemplateScope">​</a></h2><p>Different scopes for where this template is relevant</p><p style="margin-bottom:0.4em"><strong>Values</strong></p><table><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td>PERSONAL</td><td><p>This template is used for individual use only</p></td></tr><tr><td>GLOBAL</td><td><p>This template is used across users</p></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="pagetemplatesurfacetype">PageTemplateSurfaceType<a href="#pagetemplatesurfacetype" class="hash-link" aria-label="Direct link to PageTemplateSurfaceType" title="Direct link to PageTemplateSurfaceType">​</a></h2><p>Different surface areas for a page template</p><p style="margin-bottom:0.4em"><strong>Values</strong></p><table><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td>HOME_PAGE</td><td><p>This template applies to what to display on the home page for users.</p></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="partitiontype">PartitionType<a href="#partitiontype" class="hash-link" aria-label="Direct link to PartitionType" title="Direct link to PartitionType">​</a></h2><p style="margin-bottom:0.4em"><strong>Values</strong></p><table><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td>FULL_TABLE</td><td></td></tr><tr><td>QUERY</td><td></td></tr><tr><td>PARTITION</td><td></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="pe
The logical type associated with an individual Dataset</p><p style="margin-bottom:0.4em"><strong>Values</strong></p><table><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td>TABLE</td><td><p>Table</p></td></tr><tr><td>VIEW</td><td><p>View</p></td></tr><tr><td>DIRECTORY</td><td><p>Directory in file system</p></td></tr><tr><td>STREAM</td><td><p>Stream</p></td></tr><tr><td>BUCKET</td><td><p>Bucket in key value store</p></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="platformtype">PlatformType<a href="#platformtype" class="hash-link" aria-label="Direct link to PlatformType" title="Direct link to PlatformType">​</a></h2><p>The category of a specific Data Platform</p><p style="margin-bottom:0.4em"><strong>Values</strong></p><table><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td>FILE_SYSTEM</td><td><p>Value for a file system</p></td></tr><tr><td>KEY_VALUE_STORE</td><td><p>Value for a key value store</p></td></tr><tr><td>MESSAGE_BROKER</td><td><p>Value for a message broker</p></td></tr><tr><td>OBJECT_STORE</td><td><p>Value for an object store</p></td></tr><tr><td>OLAP_DATASTORE</td><td><p>Value for an OLAP datastore</p></td></tr><tr><td>QUERY_ENGINE</td><td><p>Value for a query engine</p></td></tr><tr><td>RELATIONAL_DB</td><td><p>Value for a relational database</p></td></tr><tr><td>SEARCH_ENGINE</td><td><p>Value for a search engine</p></td></tr><tr><td>OTHERS</td><td><p>Value for other platforms</p></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="policymatchcondition">PolicyMatchCondition<a href="#policymatchcondition" class="hash-link" aria-label="Direct link to PolicyMatchCondition" title="Direct link to PolicyMatchCondition">​</a></h2><p>Match condition</p><p style="margin-bottom:0.4em"><strong>Values</strong></p><table><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td>EQUALS</td><td><p>Whether the field matches the value</p></td></tr><tr><td>STARTS_WITH</td><td><p>Whether the field value starts with the value</p></td></tr><tr><td>NOT_EQUALS</td><td><p>Whether the field does not match the value</p></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="policystate">PolicyState<a href="#policystate" class="hash-link" aria-label="Direct link to PolicyState" title="Direct link to PolicyState">​</a></h2><p>The state of an Access Policy</p><p style="margin-bottom:0.4em"><strong>Values</strong></p><table><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td>DRAFT</td><td><p>A Policy that has not been officially created, but in progress Currently unused</p></td></tr><tr><td>ACTIVE</td><td><p>A Policy that is active and being enforced</p></td></tr><tr><td>INACTIVE</td><td><p>A Policy that is not active or being enforced</p></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="policytype">PolicyType<a href="#policytype" class="hash-link" aria-label="Direct link to PolicyType" title="Direct link to PolicyType">​</a></h2><p>The type of the Access Policy</p><p style="margin-bottom:0.4em"><strong>Values</strong></p><table><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td>METADATA</td><td><p>An access policy that grants privileges pertaining to Metadata Entities</p></td></tr><tr><td>PLATFORM</td><td><p>An access policy that grants top level administrative privileges pertaining to the DataHub Platform itself</p></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="postcontenttype">PostContentType<a href="#postcontenttype" class="hash-link" aria-label="Direct link to PostContentType" title="Direct link to PostContentType">​</a></h2><p>The type of post</p><p style="margin-bottom:0.4em"><strong>Values</strong></p><table><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td>TEXT</td><td><p>Text content</p></td></tr><tr><td>LINK</td><td><p>Link content</p></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="posttype">PostType<a href="#posttype" class="hash-link
can be applied to the entity from this property.</p><p style="margin-bottom:0.4em"><strong>Values</strong></p><table><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td>SINGLE</td><td><p>Only one value of this property can applied to an entity</p></td></tr><tr><td>MULTIPLE</td><td><p>Multiple values of this property can applied to an entity</p></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="querylanguage">QueryLanguage<a href="#querylanguage" class="hash-link" aria-label="Direct link to QueryLanguage" title="Direct link to QueryLanguage">​</a></h2><p>A query language / dialect.</p><p style="margin-bottom:0.4em"><strong>Values</strong></p><table><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td>SQL</td><td><p>Standard ANSI SQL</p></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="querysource">QuerySource<a href="#querysource" class="hash-link" aria-label="Direct link to QuerySource" title="Direct link to QuerySource">​</a></h2><p>The source of the query</p><p style="margin-bottom:0.4em"><strong>Values</strong></p><table><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td>MANUAL</td><td><p>The query was provided manually, e.g. from the UI.</p></td></tr><tr><td>SYSTEM</td><td><p>The query was extracted by the system, e.g. from a dashboard.</p></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="recommendationrendertype">RecommendationRenderType<a href="#recommendationrendertype" class="hash-link" aria-label="Direct link to RecommendationRenderType" title="Direct link to RecommendationRenderType">​</a></h2><p>Enum that defines how the modules should be rendered.
There should be two frontend implementation of large and small modules per type.</p><p style="margin-bottom:0.4em"><strong>Values</strong></p><table><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td>ENTITY_NAME_LIST</td><td><p>Simple list of entities</p></td></tr><tr><td>PLATFORM_SEARCH_LIST</td><td><p>List of platforms</p></td></tr><tr><td>TAG_SEARCH_LIST</td><td><p>Tag search list</p></td></tr><tr><td>SEARCH_QUERY_LIST</td><td><p>A list of recommended search queries</p></td></tr><tr><td>GLOSSARY_TERM_SEARCH_LIST</td><td><p>Glossary Term search list</p></td></tr><tr><td>DOMAIN_SEARCH_LIST</td><td><p>Domain Search List</p></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="relationshipdirection">RelationshipDirection<a href="#relationshipdirection" class="hash-link" aria-label="Direct link to RelationshipDirection" title="Direct link to RelationshipDirection">​</a></h2><p>Direction between a source and destination node</p><p style="margin-bottom:0.4em"><strong>Values</strong></p><table><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td>INCOMING</td><td><p>A directed edge pointing at the source Entity</p></td></tr><tr><td>OUTGOING</td><td><p>A directed edge pointing at the destination Entity</p></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="scenariotype">ScenarioType<a href="#scenariotype" class="hash-link" aria-label="Direct link to ScenarioType" title="Direct link to ScenarioType">​</a></h2><p>Type of the scenario requesting recommendation</p><p style="margin-bottom:0.4em"><strong>Values</strong></p><table><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td>HOME</td><td><p>Recommendations to show on the users home page</p></td></tr><tr><td>SEARCH_RESULTS</td><td><p>Recommendations to show on the search results page</p></td></tr><tr><td>ENTITY_PROFILE</td><td><p>Recommendations to show on an Entity Profile page</p></td></tr><tr><td>SEARCH_BAR</td><td><p>Recommendations to show on the search bar when clicked</p></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="schemaassertioncompatibility">SchemaAssertionCompatibility<a href="#schemaassertioncompatibility" class="hash-link" aria-label="Direct link to SchemaAssertionCompatibility" title="Direct link to SchemaAssertionCompatibility">​</a></h2><p>Defines the required compatibility level for the schema assertion to pass.</p><p style="margin-bottom:0.4em"><strong>Values</strong></p><table><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td>EXACT_MATCH</td><td><p>The schema must be exactly the same as the expected schema.</p></td></tr><tr><td>SUPERSET</td><td><p>The schema must be a superset of the expected schema.</p></td></tr><tr><td>SUBSET</td><td><p>The schema must be a subset of the expected schema.</p></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="schemafielddatatype">SchemaFieldDataType<a href="#schemafielddatatype" class="hash-link" aria-label="Direct link to SchemaFieldDataType" title="Direct link to SchemaFieldDataType">​</a></h2><p>The type associated with a single Dataset schema field</p><p style="margin-bottom:0.4em"><strong>Values</strong></p><table><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td>BOOLEAN</td><td><p>A boolean type</p></td></tr><tr><td>FIXED</td><td><p>A fixed bytestring type</p></td></tr><tr><td>STRING</td><td><p>A string type</p></td></tr><tr><td>BYTES</td><td><p>A string of bytes</p></td></tr><tr><td>NUMBER</td><td><p>A number, including integers, floats, and doubles</p></td></tr><tr><td>DATE</td><td><p>A datestrings type</p></td></tr><tr><td>TIME</td><td><p>A timestamp type</p></td></tr><tr><td>ENUM</td><td><p>An enum type</p></td></tr><tr><td>NULL</td><td><p>A NULL type</p></td></tr><tr><td>MAP</td><td><p>A map collection type</p></td></tr><tr><td>ARRAY</td><td><p>An array collection type</p></td></tr><tr><td>UNION</td><td><p>An union type</p></td></tr><tr><td>STRUCT</td><td><p>An complex struct type</p></td></tr></
<script src="/assets/js/runtime~main.a760fe73.js"></script>
<script src="/assets/js/main.a5ea2da0.js"></script>
</body>
</html>
Reference in New Issue Copy Permalink