mirror of
https://github.com/datahub-project/datahub.git
synced 2025-08-02 06:18:09 +00:00
154 lines
160 KiB
HTML
154 lines
160 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-docs/how/search" data-has-hydrated="false">
|
|||
|
|
<head>
|
|||
|
|
<meta charset="UTF-8">
|
|||
|
|
<meta name="generator" content="Docusaurus v2.4.3">
|
|||
|
|
<title data-rh="true">Search | 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/how/search"><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="Search | DataHub"><meta data-rh="true" name="description" content="The search bar is an important mechanism for discovering data assets in DataHub. From the search bar, you can find Datasets, Columns, Dashboards, Charts, Data Pipelines, and more. Simply type in a term and press 'enter'."><meta data-rh="true" property="og:description" content="The search bar is an important mechanism for discovering data assets in DataHub. From the search bar, you can find Datasets, Columns, Dashboards, Charts, Data Pipelines, and more. Simply type in a term and press 'enter'."><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://docs.datahub.com/docs/how/search"><link data-rh="true" rel="alternate" href="https://docs.datahub.com/docs/how/search" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.datahub.com/docs/how/search" 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.8ae4198a.js" as="script">
|
|||
|
|
<link rel="preload" href="/assets/js/main.9d79f7e2.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/how/search">Next</a></li><li><a class="dropdown__link" href="/docs/1.1.0/how/search">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"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--active" aria-expanded="true" href="/docs/category/features">Features</a><button aria-label="Toggle the collapsible sidebar category 'Features'" type="button" class="clean-btn menu__caret"></button></div><ul style="display:block;overflow:visible;height:auto" class="menu__list"><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" tabindex="0" href="/docs/managed-datahub/observe/assertions">Assertions (Data Quality)</a><button aria-label="Toggle the collapsible sidebar category 'Assertions (Data Quality)'" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/features/feature-guides/access-management">Access Management</a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" tabindex="0" href="/docs/automations/docs-propagation">Automations</a></div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/businessattributes">Business Attributes</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/glossary/business-glossary">Business Glossary</a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" tabindex="0" href="/docs/features/feature-guides/compliance-forms/ov
|
|||
|
|
These examples are non exhaustive and using Datasets as a reference.</p><p>If you want to:</p><ul><li><p>Exact match on term or phrase</p><ul><li><code>"pet profile"</code> <a href="https://demo.datahub.com/search?page=1&query=%22pet%20profile%22" target="_blank" rel="noopener noreferrer">Sample results</a></li><li><code>pet profile</code> <a href="https://demo.datahub.com/search?page=1&query=pet%20profile" target="_blank" rel="noopener noreferrer">Sample results</a></li><li>Enclosing one or more terms with double quotes will enforce exact matching on these terms, preventing further tokenization.</li></ul></li><li><p>Exclude terms</p><ul><li><code>logging -snowflake</code> <a href="https://demo.datahub.com/search?page=1&query=logging%20-snowflake" target="_blank" rel="noopener noreferrer">Sample results</a></li><li>Results can be excluded by term using <code>-</code> to negate the term.</li></ul></li><li><p>Term boolean logic with precedence</p><ul><li><code>logging + (-snowflake | os_audit_log)</code> <a href="https://demo.datahub.com/search?page=1&query=logging%20%2B%20%28-snowflake%20%7C%20os_audit_log%29" target="_blank" rel="noopener noreferrer">Sample results</a></li><li><code>(</code> <code>)</code> can be used to set precedence of boolean term expressions</li></ul></li><li><p>Find a dataset with the word <strong>mask</strong> in the name:</p><ul><li><code>/q name: *mask*</code> <a href="https://demo.datahub.com/search?page=1&query=%2Fq%20name%253A%2520%2Amask%2A" target="_blank" rel="noopener noreferrer">Sample results</a></li><li>This will return entities with <strong>mask</strong> in the name. Names tends to be connected by other symbols, hence the wildcard symbols before and after the word.</li></ul></li><li><p>Find a dataset with a property, <strong>encoding</strong></p><ul><li><code>/q customProperties: encoding*</code> <a href="https://demo.datahub.com/search?page=1&query=%2Fq%20customProperties%3A%20encoding%2A" target="_blank" rel="noopener noreferrer">Sample results</a></li><li>Dataset Properties are indexed in ElasticSearch the manner of key=value. Hence if you know the precise key-value pair, you can search using <code>"key=value"</code>. However, if you only know the key, you can use wildcards to replace the value and that is what is being done here.</li></ul></li><li><p>Find an entity with an <strong>unversioned</strong> structured property</p><ul><li><code>/q structuredProperties.io_acryl_privacy_retentionTime01:60</code></li><li>This will return results for an <strong>unversioned</strong> structured property's qualified name <code>io.acryl.private.retentionTime01</code> and value <code>60</code>.</li><li><code>/q _exists_:structuredProperties.io_acryl_privacy_retentionTime01</code></li><li>In this example, the query will return any entity which has any value for the <strong>unversioned</strong> structured property with qualified name <code>io.acryl.private.retentionTime01</code>.</li></ul></li><li><p>Find an entity with a <strong>versioned</strong> structured property</p><ul><li><code>/q structuredProperties._versioned.io_acryl_privacy_retentionTime.20240614080000.number:365</code></li><li>This query will return results for a <strong>versioned</strong> structured property with qualified name <code>io.acryl.privacy.retentionTime</code>, version <code>20240614080000</code>, type <code>number</code> and value <code>365</code>.</li><li><code>/q _exists_:structuredProperties._versioned.io_acryl_privacy_retentionTime.20240614080000.number</code></li><li>Returns results for a <strong>versioned</strong> structured property with qualified name <code>io.acryl.privacy.retentionTime</code>, version <code>20240614080000</code> and type <code>number</code>.</li><li><code>/q structuredProperties._versioned.io_acryl_privacy_retentionTime.\*.\*:365</code></li><li>Returns results for a <strong>versioned</strong> structured property with any version and type with a values of <code>365</code></li></ul></li><li><p>Find a dataset with a column name, <strong>latitude</str
|
|||
|
|
for integrations and programmatic use-cases.</p><div class="codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#bfc7d5;--prism-background-color:#292d3e"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#bfc7d5"><span class="token plain"># Example query - search for datasets matching the example_query_text who have the Dimension tag applied to a schema field and are from the data platform looker</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">query searchEntities {</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> search(</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> input: {</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> type: DATASET,</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> query: "example_query_text",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> orFilters: [</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> {</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> and: [</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> {</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> field: "fieldTags",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> values: ["urn:li:tag:Dimension"]</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> },</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> {</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> field: "platform",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> values: ["urn:li:dataPlatform:looker"]</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> }</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> ]</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> }</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> ],</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> start: 0,</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> count: 10</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> }</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> ) {</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> start</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> count</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> total</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> searchResults {</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> entity {</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> urn</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> type</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> ... on Dataset {</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> name</span><br></span><span class="token-lin
|
|||
|
|
This no-code solution provides the ability to extend, or replace, the Elasticsearch-based search functionality. The
|
|||
|
|
only limitation is that the information used in the query/ranking/filtering must be present in the entities' document,
|
|||
|
|
however this does include <code>customProperties</code>, <code>tags</code>, <code>terms</code>, <code>domain</code>, as well as many additional fields.</p><p>Additionally, multiple customizations can be applied to different query strings. A regex is applied to the search query
|
|||
|
|
to determine which customized search profile to use. This means a different query/ranking/filtering can be applied to
|
|||
|
|
a <code>select all</code>/<code>*</code> query or one that contains an actual query.</p><p>Search results (excluding select <code>*</code>) are a balance between relevancy and the scoring function. In
|
|||
|
|
general, when trying to improve relevancy, focus on changing the query in the <code>boolQuery</code> section and rely on the
|
|||
|
|
<code>functionScore</code> for surfacing the <em>importance</em> in the case of a relevancy tie. Consider the scenario
|
|||
|
|
where a dataset named <code>orders</code> exists in multiple places. The relevancy between the dataset with the <strong>name</strong> <code>orders</code> and
|
|||
|
|
the <strong>term</strong> <code>orders</code> is the same, however one location may be more important and thus the function score preferred.</p><p><strong>Note:</strong> The customized query is a pass-through to Elasticsearch and must comply with their API, syntax errors are possible.
|
|||
|
|
It is recommended to test the customized queries prior to production deployment and knowledge of the Elasticsearch query
|
|||
|
|
language is required.</p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="enable-custom-search">Enable Custom Search<a href="#enable-custom-search" class="hash-link" aria-label="Direct link to Enable Custom Search" title="Direct link to Enable Custom Search"></a></h3><p>The following environment variables on GMS control whether a search configuration is enabled and the location of the
|
|||
|
|
configuration file.</p><p>Enable Custom Search:</p><div class="language-shell codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#bfc7d5;--prism-background-color:#292d3e"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-shell codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#bfc7d5"><span class="token assign-left variable" style="color:rgb(191, 199, 213)">ELASTICSEARCH_QUERY_CUSTOM_CONFIG_ENABLED</span><span class="token operator" style="color:rgb(137, 221, 255)">=</span><span class="token plain">true</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>Custom Search File Location:</p><div class="language-shell codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#bfc7d5;--prism-background-color:#292d3e"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-shell codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#bfc7d5"><span class="token assign-left variable" style="color:rgb(191, 199, 213)">ELASTICSEARCH_QUERY_CUSTOM_CONFIG_FILE</span><span class="token operator" style="color:rgb(137, 221, 255)">=</span><span class="token plain">search_config.yml</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>The location of the configuration file can be on the Java classpath or the local filesystem. A default configuration
|
|||
|
|
file is included with the GMS jar with the name <code>search_config.yml</code>.</p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="search-configuration">Search Configuration<a href="#search-configuration" class="hash-link" aria-label="Direct link to Search Configuration" title="Direct link to Search Configuration"></a></h3><p>The search configuration yaml contains a simple list of configuration profiles selected using the <code>queryRegex</code>. If a
|
|||
|
|
single profile is desired, a catch-all regex of <code>.*</code> can be used.</p><p>The list of search configurations can be grouped into 4 general sections.</p><ol><li><code>queryRegex</code> - Responsible for selecting the search customization based on the <a href="https://www.w3schools.com/java/java_regex.asp" target="_blank" rel="noopener noreferrer">regex matching</a> the search query string.
|
|||
|
|
<em>The first match is applied.</em></li><li>Built-in query booleans - There are 3 built-in queries which can be individually enabled/disabled. These include
|
|||
|
|
the <code>simple query string</code><a href="https://www.elastic.co/guide/en/elasticsearch/reference/7.17/query-dsl-simple-query-string-query.html" target="_blank" rel="noopener noreferrer">[1]</a>,
|
|||
|
|
<code>match phrase prefix</code><a href="https://www.elastic.co/guide/en/elasticsearch/reference/7.17/query-dsl-match-query-phrase-prefix.html" target="_blank" rel="noopener noreferrer">[2]</a>, and
|
|||
|
|
<code>exact match</code><a href="https://www.elastic.co/guide/en/elasticsearch/reference/7.17/query-dsl-term-query.html" target="_blank" rel="noopener noreferrer">[3]</a> queries,
|
|||
|
|
enabled with the following booleans
|
|||
|
|
respectively <!-- -->[<code>simpleQuery</code>, <code>prefixMatchQuery</code>, <code>exactMatchQuery</code>]</li><li><code>boolQuery</code> - The base Elasticsearch <code>boolean query</code>[<a href="https://www.elastic.co/guide/en/elasticsearch/reference/7.17/query-dsl-bool-query.html" target="_blank" rel="noopener noreferrer">4</a>].
|
|||
|
|
If enabled in #2 above, those queries will
|
|||
|
|
appear in the <code>should</code> section of the <code>boolean query</code>[<a href="https://www.elastic.co/guide/en/elasticsearch/reference/7.17/query-dsl-bool-query.html" target="_blank" rel="noopener noreferrer">4</a>].</li><li><code>functionScore</code> - The Elasticsearch <code>function score</code>[<a href="https://www.elastic.co/guide/en/elasticsearch/reference/7.17/query-dsl-function-score-query.html#score-functions" target="_blank" rel="noopener noreferrer">5</a>] section of the overall query.</li></ol><h4 class="anchor anchorWithStickyNavbar_LWe7" id="examples">Examples<a href="#examples" class="hash-link" aria-label="Direct link to Examples" title="Direct link to Examples"></a></h4><p>These examples assume a match-all <code>queryRegex</code> of <code>.*</code> so that it would impact any search query for simplicity.</p><h5 class="anchor anchorWithStickyNavbar_LWe7" id="example-1-ranking-by-tagsterms">Example 1: Ranking By Tags/Terms<a href="#example-1-ranking-by-tagsterms" class="hash-link" aria-label="Direct link to Example 1: Ranking By Tags/Terms" title="Direct link to Example 1: Ranking By Tags/Terms"></a></h5><p>Boost entities with tags of <code>primary</code> or <code>gold</code> and an example glossary term's uuid.</p><div class="language-yaml codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#bfc7d5;--prism-background-color:#292d3e"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-yaml codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#bfc7d5"><span class="token key atrule">queryConfigurations</span><span class="token punctuation" style="color:rgb(199, 146, 234)">:</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token punctuation" style="color:rgb(199, 146, 234)">-</span><span class="token plain"> </span><span class="token key atrule">queryRegex</span><span class="token punctuation" style="color:rgb(199, 146, 234)">:</span><span class="token plain"> .*</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token key atrule">simpleQuery</span><span class="token punctuation" style="color:rgb(199, 146, 234)">:</span><span class="token plain"> </span><span class="token boolean important" style="color:rgb(255, 88, 116)">true</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token key atrule">prefixMatchQuery</span><span class="token punctuation" style="color:rgb(199, 146, 234)">:</span><span class="token plain"> </span><span class="token boolean important" style="color:rgb(255, 88, 116)">true</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token key atrule">exactMatchQuery</span><span class="token punctuation" style="color:rgb(199, 146, 234)">:</span><span class="token plain"> </span><span class="token boolean important" style="color:rgb(255, 88, 116)">true</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token key atrule">functionScore</span><span class="token punctuation" style="color:rgb(199, 146, 234)">:</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token key atrule">functions</span><span class="token punctuation" style="color:rgb(199, 146, 234)">:</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token punctuation" sty
|
|||
|
|
because they are not generally relevant as well as reduces the score of <code>materialized</code>.</p><div class="language-yaml codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#bfc7d5;--prism-background-color:#292d3e"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-yaml codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#bfc7d5"><span class="token key atrule">queryConfigurations</span><span class="token punctuation" style="color:rgb(199, 146, 234)">:</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token punctuation" style="color:rgb(199, 146, 234)">-</span><span class="token plain"> </span><span class="token key atrule">queryRegex</span><span class="token punctuation" style="color:rgb(199, 146, 234)">:</span><span class="token plain"> .*</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token key atrule">simpleQuery</span><span class="token punctuation" style="color:rgb(199, 146, 234)">:</span><span class="token plain"> </span><span class="token boolean important" style="color:rgb(255, 88, 116)">true</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token key atrule">prefixMatchQuery</span><span class="token punctuation" style="color:rgb(199, 146, 234)">:</span><span class="token plain"> </span><span class="token boolean important" style="color:rgb(255, 88, 116)">true</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token key atrule">exactMatchQuery</span><span class="token punctuation" style="color:rgb(199, 146, 234)">:</span><span class="token plain"> </span><span class="token boolean important" style="color:rgb(255, 88, 116)">true</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token key atrule">boolQuery</span><span class="token punctuation" style="color:rgb(199, 146, 234)">:</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token key atrule">must_not</span><span class="token punctuation" style="color:rgb(199, 146, 234)">:</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token key atrule">term</span><span class="token punctuation" style="color:rgb(199, 146, 234)">:</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token key atrule">deprecated</span><span class="token punctuation" style="color:rgb(199, 146, 234)">:</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token key atrule">value</span><span class="token punctuation" style="color:rgb(199, 146, 234)">:</span><span class="token plain"> </span><span class="token boolean important" style="color:rgb(255, 88, 116)">true</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token key atrule">functionScore</span><span class="token punctuation" style="color:rgb(199, 146, 234)">:</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span
|
|||
|
|
to appear above charts. This can be done using the following function score and leverages a prefix match on the entity type
|
|||
|
|
of the URN. Depending on the entity the weight may have to be adjusted based on your data and the entities
|
|||
|
|
involved since often multiple field matches may shift weight towards one entity vs another.</p><div class="language-yaml codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#bfc7d5;--prism-background-color:#292d3e"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-yaml codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#bfc7d5"><span class="token key atrule">queryConfigurations</span><span class="token punctuation" style="color:rgb(199, 146, 234)">:</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token punctuation" style="color:rgb(199, 146, 234)">-</span><span class="token plain"> </span><span class="token key atrule">queryRegex</span><span class="token punctuation" style="color:rgb(199, 146, 234)">:</span><span class="token plain"> .*</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token key atrule">simpleQuery</span><span class="token punctuation" style="color:rgb(199, 146, 234)">:</span><span class="token plain"> </span><span class="token boolean important" style="color:rgb(255, 88, 116)">true</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token key atrule">prefixMatchQuery</span><span class="token punctuation" style="color:rgb(199, 146, 234)">:</span><span class="token plain"> </span><span class="token boolean important" style="color:rgb(255, 88, 116)">true</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token key atrule">exactMatchQuery</span><span class="token punctuation" style="color:rgb(199, 146, 234)">:</span><span class="token plain"> </span><span class="token boolean important" style="color:rgb(255, 88, 116)">true</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token key atrule">functionScore</span><span class="token punctuation" style="color:rgb(199, 146, 234)">:</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token key atrule">functions</span><span class="token punctuation" style="color:rgb(199, 146, 234)">:</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token punctuation" style="color:rgb(199, 146, 234)">-</span><span class="token plain"> </span><span class="token key atrule">filter</span><span class="token punctuation" style="color:rgb(199, 146, 234)">:</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token key atrule">prefix</span><span class="token punctuation" style="color:rgb(199, 146, 234)">:</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token key atrule">urn</span><span class="token punctuation" style="color:rgb(199, 146, 234)">:</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token key atrule">value</span><span class="token punctuation" style="color:rgb(199, 146, 234)">:</span><span class="token plain"> </span><span class="token string" style="color:rgb(195, 232, 141)">"urn:li:dashboard:"</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><
|
|||
|
|
which can be configured.</p><p>Note: The scoring functions defined in the previous section are inherited for autocomplete by default, unless
|
|||
|
|
overrides are provided in the autocomplete section.</p><p>For the most part the configuration options are identical to the search customization options in the previous
|
|||
|
|
section, however they are located under <code>autocompleteConfigurations</code> in the yaml configuration file.</p><ol><li><code>queryRegex</code> - Responsible for selecting the search customization based on the <a href="https://www.w3schools.com/java/java_regex.asp" target="_blank" rel="noopener noreferrer">regex matching</a> the search query string.
|
|||
|
|
<em>The first match is applied.</em></li><li>The following boolean enables/disables the function score inheritance from the normal search configuration: <!-- -->[<code>inheritFunctionScore</code>]<!-- -->
|
|||
|
|
This flag will automatically be set to <code>false</code> when the <code>functionScore</code> section is provided. If set to <code>false</code> with no
|
|||
|
|
<code>functionScore</code> provided, the default Elasticsearch <code>_score</code> is used.</li><li>Built-in query booleans - There is 1 built-in query which can be enabled/disabled. These include
|
|||
|
|
the <code>default autocomplete query</code> query,
|
|||
|
|
enabled with the following booleans
|
|||
|
|
respectively <!-- -->[<code>defaultQuery</code>]</li><li><code>boolQuery</code> - The base Elasticsearch <code>boolean query</code>[<a href="https://www.elastic.co/guide/en/elasticsearch/reference/7.17/query-dsl-bool-query.html" target="_blank" rel="noopener noreferrer">4</a>].
|
|||
|
|
If enabled in #2 above, those queries will
|
|||
|
|
appear in the <code>should</code> section of the <code>boolean query</code>[<a href="https://www.elastic.co/guide/en/elasticsearch/reference/7.17/query-dsl-bool-query.html" target="_blank" rel="noopener noreferrer">4</a>].</li><li><code>functionScore</code> - The Elasticsearch <code>function score</code>[<a href="https://www.elastic.co/guide/en/elasticsearch/reference/7.17/query-dsl-function-score-query.html#score-functions" target="_blank" rel="noopener noreferrer">5</a>] section of the overall query.</li></ol><h4 class="anchor anchorWithStickyNavbar_LWe7" id="examples-1">Examples<a href="#examples-1" class="hash-link" aria-label="Direct link to Examples" title="Direct link to Examples"></a></h4><p>These examples assume a match-all <code>queryRegex</code> of <code>.*</code> so that it would impact any search query for simplicity. Also
|
|||
|
|
note that the <code>queryRegex</code> is applied individually for <code>searchConfigurations</code> and <code>autocompleteConfigurations</code> and they
|
|||
|
|
do not have to be identical.</p><h5 class="anchor anchorWithStickyNavbar_LWe7" id="example-1-exclude-deprecated-entities-from-autocomplete">Example 1: Exclude <code>deprecated</code> entities from autocomplete<a href="#example-1-exclude-deprecated-entities-from-autocomplete" class="hash-link" aria-label="Direct link to example-1-exclude-deprecated-entities-from-autocomplete" title="Direct link to example-1-exclude-deprecated-entities-from-autocomplete"></a></h5><div class="language-yaml codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#bfc7d5;--prism-background-color:#292d3e"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-yaml codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#bfc7d5"><span class="token key atrule">autocompleteConfigurations</span><span class="token punctuation" style="color:rgb(199, 146, 234)">:</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token punctuation" style="color:rgb(199, 146, 234)">-</span><span class="token plain"> </span><span class="token key atrule">queryRegex</span><span class="token punctuation" style="color:rgb(199, 146, 234)">:</span><span class="token plain"> .*</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token key atrule">defaultQuery</span><span class="token punctuation" style="color:rgb(199, 146, 234)">:</span><span class="token plain"> </span><span class="token boolean important" style="color:rgb(255, 88, 116)">true</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token key atrule">boolQuery</span><span class="token punctuation" style="color:rgb(199, 146, 234)">:</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token key atrule">must</span><span class="token punctuation" style="color:rgb(199, 146, 234)">:</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token punctuation" style="color:rgb(199, 146, 234)">-</span><span class="token plain"> </span><span class="token key atrule">term</span><span class="token punctuation" style="color:rgb(199, 146, 234)">:</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token key atrule">deprecated</span><span class="token punctuation" style="color:rgb(199, 146, 234)">:</span><span class="token plain"> </span><span class="token string" style="color:rgb(195, 232, 141)">"false"</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h4 class="anchor anchorWithStickyNavbar_LWe7" id="example-2-override-scoring-for-autocomplete">Example 2: Override scoring for autocomplete<a href="#example-2-override-scoring-for-autocomplete" class="hash-link" aria-label="Direct link to Example 2: Override scoring for autocomplete" title="Direct link to Example 2: Override scoring for autocomplete"></a></h4><div class="language-yaml codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#bfc7d5;--prism-background-color
|
|||
|
|
<!-- -->However, it does not tell you the specific attribute name to use for specialized searches. One way to do so is to inspect the ElasticSearch indices, for example:<br>
|
|||
|
|
<code>curl http://localhost:9200/_cat/indices</code> returns all the ES indices in the ElasticSearch container.</p><div class="codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#bfc7d5;--prism-background-color:#292d3e"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#bfc7d5"><span class="token plain">yellow open chartindex_v2_1643510690325 bQO_RSiCSUiKJYsmJClsew 1 1 2 0 8.5kb 8.5kb</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">yellow open mlmodelgroupindex_v2_1643510678529 OjIy0wb7RyKqLz3uTENRHQ 1 1 0 0 208b 208b</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">yellow open dataprocessindex_v2_1643510676831 2w-IHpuiTUCs6e6gumpYHA 1 1 0 0 208b 208b</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">yellow open corpgroupindex_v2_1643510673894 O7myCFlqQWKNtgsldzBS6g 1 1 3 0 16.8kb 16.8kb</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">yellow open corpuserindex_v2_1643510672335 0rIe_uIQTjme5Wy61MFbaw 1 1 6 2 32.4kb 32.4kb</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">yellow open datasetindex_v2_1643510688970 bjBfUEswSoSqPi3BP4iqjw 1 1 15 0 29.2kb 29.2kb</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">yellow open dataflowindex_v2_1643510681607 N8CMlRFvQ42rnYMVDaQJ2g 1 1 1 0 10.2kb 10.2kb</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">yellow open dataset_datasetusagestatisticsaspect_v1_1643510694706 kdqvqMYLRWq1oZt1pcAsXQ 1 1 4 0 8.9kb 8.9kb</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">yellow open .ds-datahub_usage_event-000003 YMVcU8sHTFilUwyI4CWJJg 1 1 186 0 203.9kb 203.9kb</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">yellow open datajob_datahubingestioncheckpointaspect_v1 nTXJf7C1Q3GoaIJ71gONxw 1 1 0 0 208b 208b</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">yellow open .ds-datahub_usage_event-000004 XRFwisRPSJuSr6UVmmsCsg 1 1 196 0 165.5kb 165.5kb</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">yellow open .ds-datahub_usage_event-000005 d0O6l5wIRLOyG6iIfAISGw 1 1 77 0 108.1kb 108.1kb</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">yellow open dataplatformindex_v2_1643510671426 _4SIIhfAT8yq_WROufunXA 1 1 0 0 208b 208b</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">yellow open mlmodeldeploymentindex_v2_1643510670629 n81eJIypSp2Qx-fpjZHgRw 1 1 0 0 208b 208b</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">yellow open .ds-datahub_usage_event-000006 oyrWKndjQ-a8Rt1IMD9aSA 1 1 143 0 127.1kb 127.1kb</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">yellow open mlfeaturetableindex_v2_1643510677164 iEXPt637S1OcilXpxPNYHw 1 1 5 0 8.9kb 8.9kb</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">yellow open .ds-datahub_usage_event-000001 S9EnGj64TEW8O3sLUb9I2Q 1 1 257 0 163.9kb 163.9kb</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">yellow open .ds-datahub_usage_event-000002 2xJyvKG_RYGwJOG9yq8pJw 1 1 44 0 155.4kb 155.4kb</span><br></span><span class="token-line
|
|||
|
|
<code>curl http://localhost:9200/datasetindex_v2_1643510688970/_search?=pretty</code></p><p>example information of a dataset:</p><div class="codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#bfc7d5;--prism-background-color:#292d3e"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#bfc7d5"><span class="token plain">{</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "_index" : "datasetindex_v2_1643510688970",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "_type" : "_doc",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "_id" : "urn%3Ali%3Adataset%3A%28urn%3Ali%3AdataPlatform%3Akafka%2CSampleKafkaDataset%2CPROD%29",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "_score" : 1.0,</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "_source" : {</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "urn" : "urn:li:dataset:(urn:li:dataPlatform:kafka,SampleKafkaDataset,PROD)",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "name" : "SampleKafkaDataset",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "browsePaths" : [</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "/prod/kafka/SampleKafkaDataset"</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> ],</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "origin" : "PROD",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "customProperties" : [</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "prop2=pikachu",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "prop1=fakeprop"</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> ],</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "hasDescription" : false,</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "hasOwners" : true,</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "owners" : [</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "urn:li:corpuser:jdoe",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "urn:li:corpuser:datahub"</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> ],</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "fieldPaths" : [</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "[version=2.0].[type=boolean].field_foo_2",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "[version=2.0].[type=boolean].field_bar",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "[version=2.0].[key=True].[type=int].id"</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> ],</span><br></span><span class="token-line" style
|
|||
|
|
<script src="/assets/js/runtime~main.8ae4198a.js"></script>
|
|||
|
|
<script src="/assets/js/main.9d79f7e2.js"></script>
|
|||
|
|
</body>
|
|||
|
|
</html>
|