yujunjun/datahub
2
0
Fork 0
mirror of https://github.com/datahub-project/datahub.git synced 2025-08-31 21:03:03 +00:00
Code Issues Packages Projects Releases Wiki Activity
datahub/assets/js/b68ece50.4fec77b5.js
chriscollins3456 d9181465b4 deploy: d9dda1b059f2bbbef31e92009aba40fbc75df7e2
2025-08-22 14:09:31 +00:00

1 line
34 KiB
JavaScript
Raw Blame History

"use strict";(self.webpackChunkdocs_website=self.webpackChunkdocs_website||[]).push([[57677],{15680:(e,n,i)=>{i.d(n,{xA:()=>s,yg:()=>N});var a=i(96540);function t(e,n,i){return n in e?Object.defineProperty(e,n,{value:i,enumerable:!0,configurable:!0,writable:!0}):e[n]=i,e}function l(e,n){var i=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);n&&(a=a.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),i.push.apply(i,a)}return i}function r(e){for(var n=1;n<arguments.length;n++){var i=null!=arguments[n]?arguments[n]:{};n%2?l(Object(i),!0).forEach((function(n){t(e,n,i[n])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(i)):l(Object(i)).forEach((function(n){Object.defineProperty(e,n,Object.getOwnPropertyDescriptor(i,n))}))}return e}function o(e,n){if(null==e)return{};var i,a,t=function(e,n){if(null==e)return{};var i,a,t={},l=Object.keys(e);for(a=0;a<l.length;a++)i=l[a],n.indexOf(i)>=0||(t[i]=e[i]);return t}(e,n);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(a=0;a<l.length;a++)i=l[a],n.indexOf(i)>=0||Object.prototype.propertyIsEnumerable.call(e,i)&&(t[i]=e[i])}return t}var y=a.createContext({}),p=function(e){var n=a.useContext(y),i=n;return e&&(i="function"==typeof e?e(n):r(r({},n),e)),i},s=function(e){var n=p(e.components);return a.createElement(y.Provider,{value:n},e.children)},m="mdxType",g={inlineCode:"code",wrapper:function(e){var n=e.children;return a.createElement(a.Fragment,{},n)}},d=a.forwardRef((function(e,n){var i=e.components,t=e.mdxType,l=e.originalType,y=e.parentName,s=o(e,["components","mdxType","originalType","parentName"]),m=p(i),d=t,N=m["".concat(y,".").concat(d)]||m[d]||g[d]||l;return i?a.createElement(N,r(r({ref:n},s),{},{components:i})):a.createElement(N,r({ref:n},s))}));function N(e,n){var i=arguments,t=n&&n.mdxType;if("string"==typeof e||t){var l=i.length,r=new Array(l);r[0]=d;var o={};for(var y in n)hasOwnProperty.call(n,y)&&(o[y]=n[y]);o.originalType=e,o[m]="string"==typeof e?e:t,r[1]=o;for(var p=2;p<l;p++)r[p]=i[p];return a.createElement.apply(null,r)}return a.createElement.apply(null,i)}d.displayName="MDXCreateElement"},53160:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>s,contentTitle:()=>y,default:()=>N,frontMatter:()=>o,metadata:()=>p,toc:()=>m});i(96540);var a=i(15680);function t(e,n,i){return n in e?Object.defineProperty(e,n,{value:i,enumerable:!0,configurable:!0,writable:!0}):e[n]=i,e}function l(e,n){return n=null!=n?n:{},Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(n)):function(e,n){var i=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);n&&(a=a.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),i.push.apply(i,a)}return i}(Object(n)).forEach((function(i){Object.defineProperty(e,i,Object.getOwnPropertyDescriptor(n,i))})),e}function r(e,n){if(null==e)return{};var i,a,t=function(e,n){if(null==e)return{};var i,a,t={},l=Object.keys(e);for(a=0;a<l.length;a++)i=l[a],n.indexOf(i)>=0||(t[i]=e[i]);return t}(e,n);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(a=0;a<l.length;a++)i=l[a],n.indexOf(i)>=0||Object.prototype.propertyIsEnumerable.call(e,i)&&(t[i]=e[i])}return t}const o={title:"Search Client"},y=void 0,p={unversionedId:"python-sdk/sdk-v2/search-client",id:"python-sdk/sdk-v2/search-client",title:"Search Client",description:"The DataHub Search Client provides a client for searching and retrieving metadata from DataHub.",source:"@site/genDocs/python-sdk/sdk-v2/search-client.mdx",sourceDirName:"python-sdk/sdk-v2",slug:"/python-sdk/sdk-v2/search-client",permalink:"/docs/python-sdk/sdk-v2/search-client",draft:!1,editUrl:"https://github.com/datahub-project/datahub/blob/master/genDocs/python-sdk/sdk-v2/search-client.mdx",tags:[],version:"current",frontMatter:{title:"Search Client"},sidebar:"overviewSidebar",previous:{title:"Resolver Client",permalink:"/docs/python-sdk/sdk-v2/resolver-client"},next:{title:"Models",permalink:"/docs/python-sdk/models"}},s={},m=[{value:'<span className="visually-hidden">SearchClient</span>',id:"datahub.sdk.search_client.SearchClient",level:3},{value:"get_urns(query=None, filter=None, *, skip_cache=False)",id:"get_urnsquerynone-filternone--skip_cachefalse",level:4},{value:'<span className="visually-hidden">compile_filters</span>',id:"datahub.sdk.search_client.compile_filters",level:3},{value:'<span className="visually-hidden">compute_entity_types</span>',id:"datahub.sdk.search_client.compute_entity_types",level:3},{value:'<span className="visually-hidden">FilterDsl</span>',id:"datahub.sdk.search_filters.FilterDsl",level:3},{value:"<em>static</em> and_(*args)",id:"static-and_args",level:4},{value:"<em>static</em> container(container, /, *, direct_descendants_only=False)",id:"static-containercontainer---direct_descendants_onlyfalse",level:4},{value:"<em>static</em> custom_filter(field, condition, values)",id:"static-custom_filterfield-condition-values",level:4},{value:"<em>static</em> domain(domain, /)",id:"static-domaindomain-",level:4},{value:"<em>static</em> entity_subtype(entity_subtype)",id:"static-entity_subtypeentity_subtype",level:4},{value:"<em>static</em> entity_type(entity_type)",id:"static-entity_typeentity_type",level:4},{value:"<em>static</em> env(env, /)",id:"static-envenv-",level:4},{value:"<em>static</em> false()",id:"static-false",level:4},{value:"<em>static</em> has_custom_property(key, value)",id:"static-has_custom_propertykey-value",level:4},{value:"<em>static</em> not_(arg)",id:"static-not_arg",level:4},{value:"<em>static</em> or_(*args)",id:"static-or_args",level:4},{value:"<em>static</em> platform(platform, /)",id:"static-platformplatform-",level:4},{value:"<em>static</em> soft_deleted(status)",id:"static-soft_deletedstatus",level:4},{value:"<em>static</em> true()",id:"static-true",level:4},{value:'<span className="visually-hidden">load_filters</span>',id:"datahub.sdk.search_filters.load_filters",level:3}],g={toc:m},d="wrapper";function N(e){var{components:n}=e,i=r(e,["components"]);return(0,a.yg)(d,l(function(e){for(var n=1;n<arguments.length;n++){var i=null!=arguments[n]?arguments[n]:{},a=Object.keys(i);"function"==typeof Object.getOwnPropertySymbols&&(a=a.concat(Object.getOwnPropertySymbols(i).filter((function(e){return Object.getOwnPropertyDescriptor(i,e).enumerable})))),a.forEach((function(n){t(e,n,i[n])}))}return e}({},g,i),{components:n,mdxType:"MDXLayout"}),(0,a.yg)("div",{className:"sphinx-api-docs"},(0,a.yg)("a",{id:"search-client"}),(0,a.yg)("p",null,"The DataHub Search Client provides a client for searching and retrieving metadata from DataHub."),(0,a.yg)("p",null,"If you\u2019re looking for higher-level introduction to searching using the SDK, see the ",(0,a.yg)("a",{parentName:"p",href:"/docs/api/tutorials/sdk/search_client"},"search guide"),"."),(0,a.yg)("h3",{id:"datahub.sdk.search_client.SearchClient"},(0,a.yg)("span",{className:"visually-hidden"},"SearchClient")),(0,a.yg)("div",{className:"h3-block"},(0,a.yg)("div",{className:"section-heading"},(0,a.yg)("span",{class:"class-text"},"class")," ",(0,a.yg)("span",{class:"class-owner"},"datahub.sdk.search_client."),(0,a.yg)("span",{class:"class-name"},"SearchClient"),"(",(0,a.yg)("span",{class:"arg-name"},"client"),")",(0,a.yg)("a",{href:"#datahub.sdk.search_client.SearchClient",class:"hash-link"})),(0,a.yg)("p",null,"Bases: ",(0,a.yg)("inlineCode",{parentName:"p"},"object")),(0,a.yg)("ul",null,(0,a.yg)("li",{parentName:"ul"},(0,a.yg)("strong",{parentName:"li"},"Parameters:"),(0,a.yg)("strong",{parentName:"li"},"client")," (",(0,a.yg)("a",{parentName:"li",href:"/docs/python-sdk/sdk-v2/main-client#datahub.sdk.main_client.DataHubClient"},(0,a.yg)("inlineCode",{parentName:"a"},"DataHubClient")),") \u2013 ")),(0,a.yg)("h4",{id:"get_urnsquerynone-filternone--skip_cachefalse"},"get_urns(query=None, filter=None, ","*",", skip_cache=False)"),(0,a.yg)("ul",null,(0,a.yg)("li",{parentName:"ul"},(0,a.yg)("strong",{parentName:"li"},"Parameters:"),(0,a.yg)("ul",{parentName:"li"},(0,a.yg)("li",{parentName:"ul"},(0,a.yg)("strong",{parentName:"li"},"query")," (",(0,a.yg)("inlineCode",{parentName:"li"},"Optional"),"[",(0,a.yg)("inlineCode",{parentName:"li"},"str"),"]",")"),(0,a.yg)("li",{parentName:"ul"},(0,a.yg)("strong",{parentName:"li"},"filter")," (",(0,a.yg)("inlineCode",{parentName:"li"},"Union"),"[",(0,a.yg)("inlineCode",{parentName:"li"},"_And"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"_Or"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"_Not"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"_EntityTypeFilter"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"_EntitySubtypeFilter"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"_StatusFilter"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"_PlatformFilter"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"_DomainFilter"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"_ContainerFilter"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"_EnvFilter"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"_CustomCondition"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"None"),"]",")"),(0,a.yg)("li",{parentName:"ul"},(0,a.yg)("strong",{parentName:"li"},"skip_cache")," (",(0,a.yg)("inlineCode",{parentName:"li"},"bool"),")"))),(0,a.yg)("li",{parentName:"ul"},(0,a.yg)("strong",{parentName:"li"},"Return type:"),(0,a.yg)("inlineCode",{parentName:"li"},"Iterable"),"[",(0,a.yg)("a",{parentName:"li",href:"/docs/python-sdk/urns#datahub.metadata.urns.Urn"},(0,a.yg)("inlineCode",{parentName:"a"},"Urn")),"]"))),(0,a.yg)("h3",{id:"datahub.sdk.search_client.compile_filters"},(0,a.yg)("span",{className:"visually-hidden"},"compile_filters")),(0,a.yg)("div",{className:"h3-block"},(0,a.yg)("div",{className:"section-heading"},(0,a.yg)("span",{class:"class-owner"},"datahub.sdk.search_client."),(0,a.yg)("span",{class:"class-name"},"compile_filters"),"(",(0,a.yg)("span",{class:"arg-name"},"filter"),")",(0,a.yg)("a",{href:"#datahub.sdk.search_client.compile_filters",class:"hash-link"})),(0,a.yg)("ul",null,(0,a.yg)("li",{parentName:"ul"},(0,a.yg)("strong",{parentName:"li"},"Parameters:"),(0,a.yg)("strong",{parentName:"li"},"filter")," (",(0,a.yg)("inlineCode",{parentName:"li"},"Union"),"[",(0,a.yg)("inlineCode",{parentName:"li"},"_And"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"_Or"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"_Not"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"_EntityTypeFilter"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"_EntitySubtypeFilter"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"_StatusFilter"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"_PlatformFilter"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"_DomainFilter"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"_ContainerFilter"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"_EnvFilter"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"_CustomCondition"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"None"),"]",")"),(0,a.yg)("li",{parentName:"ul"},(0,a.yg)("strong",{parentName:"li"},"Return type:"),(0,a.yg)("inlineCode",{parentName:"li"},"Tuple"),"[",(0,a.yg)("inlineCode",{parentName:"li"},"Optional"),"[",(0,a.yg)("inlineCode",{parentName:"li"},"List"),"[",(0,a.yg)("inlineCode",{parentName:"li"},"str"),"]","], ",(0,a.yg)("inlineCode",{parentName:"li"},"List"),"[",(0,a.yg)("inlineCode",{parentName:"li"},"Dict"),"[",(0,a.yg)("inlineCode",{parentName:"li"},"Literal"),"[",(0,a.yg)("inlineCode",{parentName:"li"},"'and'"),"]",", ",(0,a.yg)("inlineCode",{parentName:"li"},"List"),"[",(0,a.yg)("inlineCode",{parentName:"li"},"Dict"),"[",(0,a.yg)("inlineCode",{parentName:"li"},"str"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"Union"),"[",(0,a.yg)("inlineCode",{parentName:"li"},"str"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"bool"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"List"),"[",(0,a.yg)("inlineCode",{parentName:"li"},"str"),"]","]]]]]]"))),(0,a.yg)("h3",{id:"datahub.sdk.search_client.compute_entity_types"},(0,a.yg)("span",{className:"visually-hidden"},"compute_entity_types")),(0,a.yg)("div",{className:"h3-block"},(0,a.yg)("div",{className:"section-heading"},(0,a.yg)("span",{class:"class-owner"},"datahub.sdk.search_client."),(0,a.yg)("span",{class:"class-name"},"compute_entity_types"),"(",(0,a.yg)("span",{class:"arg-name"},"filters"),")",(0,a.yg)("a",{href:"#datahub.sdk.search_client.compute_entity_types",class:"hash-link"})),(0,a.yg)("ul",null,(0,a.yg)("li",{parentName:"ul"},(0,a.yg)("strong",{parentName:"li"},"Parameters:"),(0,a.yg)("strong",{parentName:"li"},"filters")," (",(0,a.yg)("inlineCode",{parentName:"li"},"List"),"[",(0,a.yg)("inlineCode",{parentName:"li"},"_AndSearchFilterRule"),"]",")"),(0,a.yg)("li",{parentName:"ul"},(0,a.yg)("strong",{parentName:"li"},"Return type:"),(0,a.yg)("inlineCode",{parentName:"li"},"Optional"),"[",(0,a.yg)("inlineCode",{parentName:"li"},"List"),"[",(0,a.yg)("inlineCode",{parentName:"li"},"str"),"]","]"))),(0,a.yg)("h3",{id:"datahub.sdk.search_filters.FilterDsl"},(0,a.yg)("span",{className:"visually-hidden"},"FilterDsl")),(0,a.yg)("div",{className:"h3-block"},(0,a.yg)("div",{className:"section-heading"},(0,a.yg)("span",{class:"class-text"},"class")," ",(0,a.yg)("span",{class:"class-owner"},"datahub.sdk.search_filters."),(0,a.yg)("span",{class:"class-name"},"FilterDsl"),"()",(0,a.yg)("a",{href:"#datahub.sdk.search_filters.FilterDsl",class:"hash-link"})),(0,a.yg)("p",null,"Bases: ",(0,a.yg)("inlineCode",{parentName:"p"},"object")),(0,a.yg)("h4",{id:"static-and_args"},(0,a.yg)("em",{parentName:"h4"},"static")," and_(","*","args)"),(0,a.yg)("ul",null,(0,a.yg)("li",{parentName:"ul"},(0,a.yg)("strong",{parentName:"li"},"Parameters:"),(0,a.yg)("strong",{parentName:"li"},"args")," (",(0,a.yg)("inlineCode",{parentName:"li"},"Union"),"[",(0,a.yg)("inlineCode",{parentName:"li"},"_And"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"_Or"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"_Not"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"_EntityTypeFilter"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"_EntitySubtypeFilter"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"_StatusFilter"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"_PlatformFilter"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"_DomainFilter"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"_ContainerFilter"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"_EnvFilter"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"_CustomCondition"),"]",")"),(0,a.yg)("li",{parentName:"ul"},(0,a.yg)("strong",{parentName:"li"},"Return type:"),(0,a.yg)("inlineCode",{parentName:"li"},"_And"))),(0,a.yg)("h4",{id:"static-containercontainer---direct_descendants_onlyfalse"},(0,a.yg)("em",{parentName:"h4"},"static")," container(container, /, ","*",", direct_descendants_only=False)"),(0,a.yg)("ul",null,(0,a.yg)("li",{parentName:"ul"},(0,a.yg)("strong",{parentName:"li"},"Parameters:"),(0,a.yg)("ul",{parentName:"li"},(0,a.yg)("li",{parentName:"ul"},(0,a.yg)("strong",{parentName:"li"},"container")," (",(0,a.yg)("inlineCode",{parentName:"li"},"Union"),"[",(0,a.yg)("inlineCode",{parentName:"li"},"str"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"Sequence"),"[",(0,a.yg)("inlineCode",{parentName:"li"},"str"),"]","])"),(0,a.yg)("li",{parentName:"ul"},(0,a.yg)("strong",{parentName:"li"},"direct_descendants_only")," (",(0,a.yg)("inlineCode",{parentName:"li"},"bool"),")"))),(0,a.yg)("li",{parentName:"ul"},(0,a.yg)("strong",{parentName:"li"},"Return type:"),(0,a.yg)("inlineCode",{parentName:"li"},"_ContainerFilter"))),(0,a.yg)("h4",{id:"static-custom_filterfield-condition-values"},(0,a.yg)("em",{parentName:"h4"},"static")," custom_filter(field, condition, values)"),(0,a.yg)("ul",null,(0,a.yg)("li",{parentName:"ul"},(0,a.yg)("strong",{parentName:"li"},"Parameters:"),(0,a.yg)("ul",{parentName:"li"},(0,a.yg)("li",{parentName:"ul"},(0,a.yg)("strong",{parentName:"li"},"field")," (",(0,a.yg)("inlineCode",{parentName:"li"},"str"),")"),(0,a.yg)("li",{parentName:"ul"},(0,a.yg)("strong",{parentName:"li"},"condition")," (",(0,a.yg)("inlineCode",{parentName:"li"},"Literal"),"[",(0,a.yg)("inlineCode",{parentName:"li"},"'CONTAIN'"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"'EQUAL'"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"'IEQUAL'"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"'IN'"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"'EXISTS'"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"'GREATER_THAN'"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"'GREATER_THAN_OR_EQUAL_TO'"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"'LESS_THAN'"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"'LESS_THAN_OR_EQUAL_TO'"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"'START_WITH'"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"'END_WITH'"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"'DESCENDANTS_INCL'"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"'ANCESTORS_INCL'"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"'RELATED_INCL'"),"]",")"),(0,a.yg)("li",{parentName:"ul"},(0,a.yg)("strong",{parentName:"li"},"values")," (",(0,a.yg)("inlineCode",{parentName:"li"},"Sequence"),"[",(0,a.yg)("inlineCode",{parentName:"li"},"str"),"]",")"))),(0,a.yg)("li",{parentName:"ul"},(0,a.yg)("strong",{parentName:"li"},"Return type:"),(0,a.yg)("inlineCode",{parentName:"li"},"_CustomCondition"))),(0,a.yg)("h4",{id:"static-domaindomain-"},(0,a.yg)("em",{parentName:"h4"},"static")," domain(domain, /)"),(0,a.yg)("ul",null,(0,a.yg)("li",{parentName:"ul"},(0,a.yg)("strong",{parentName:"li"},"Parameters:"),(0,a.yg)("strong",{parentName:"li"},"domain")," (",(0,a.yg)("inlineCode",{parentName:"li"},"Union"),"[",(0,a.yg)("inlineCode",{parentName:"li"},"str"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"Sequence"),"[",(0,a.yg)("inlineCode",{parentName:"li"},"str"),"]","])"),(0,a.yg)("li",{parentName:"ul"},(0,a.yg)("strong",{parentName:"li"},"Return type:"),(0,a.yg)("inlineCode",{parentName:"li"},"_DomainFilter"))),(0,a.yg)("h4",{id:"static-entity_subtypeentity_subtype"},(0,a.yg)("em",{parentName:"h4"},"static")," entity_subtype(entity_subtype)"),(0,a.yg)("ul",null,(0,a.yg)("li",{parentName:"ul"},(0,a.yg)("strong",{parentName:"li"},"Parameters:"),(0,a.yg)("strong",{parentName:"li"},"entity_subtype")," (",(0,a.yg)("inlineCode",{parentName:"li"},"Union"),"[",(0,a.yg)("inlineCode",{parentName:"li"},"str"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"Sequence"),"[",(0,a.yg)("inlineCode",{parentName:"li"},"str"),"]","])"),(0,a.yg)("li",{parentName:"ul"},(0,a.yg)("strong",{parentName:"li"},"Return type:"),(0,a.yg)("inlineCode",{parentName:"li"},"_EntitySubtypeFilter"))),(0,a.yg)("h4",{id:"static-entity_typeentity_type"},(0,a.yg)("em",{parentName:"h4"},"static")," entity_type(entity_type)"),(0,a.yg)("ul",null,(0,a.yg)("li",{parentName:"ul"},(0,a.yg)("strong",{parentName:"li"},"Parameters:"),(0,a.yg)("strong",{parentName:"li"},"entity_type")," (",(0,a.yg)("inlineCode",{parentName:"li"},"Union"),"[",(0,a.yg)("inlineCode",{parentName:"li"},"Literal"),"[",(0,a.yg)("inlineCode",{parentName:"li"},"'erModelRelationship'"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"'dataHubSecret'"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"'dataHubPolicy'"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"'schemaField'"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"'ownershipType'"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"'telemetry'"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"'dataHubConnection'"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"'dataHubAction'"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"'corpGroup'"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"'glossaryNode'"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"'dashboard'"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"'mlModelDeployment'"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"'dataHubExecutionRequest'"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"'inviteToken'"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"'role'"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"'chart'"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"'test'"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"'dataFlow'"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"'dataPlatformInstance'"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"'form'"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"'glossaryTerm'"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"'dataHubRole'"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"'dataHubPageTemplate'"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"'dataHubUpgrade'"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"'dataHubRetention'"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"'globalSettings'"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"'corpuser'"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"'mlPrimaryKey'"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"'dataHubOpenAPISchema'"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"'assertion'"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"'mlModelGroup'"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"'dataPlatform'"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"'dataHubView'"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"'dataHubAccessToken'"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"'container'"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"'mlFeatureTable'"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"'tag'"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"'post'"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"'query'"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"'incident'"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"'dataJob'"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"'dataProcess'"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"'notebook'"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"'dataHubPersona'"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"'dataContract'"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"'dataHubStepState'"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"'dataset'"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"'dataHubPageModule'"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"'dataProcessInstance'"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"'domain'"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"'versionSet'"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"'dataHubIngestionSource'"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"'mlModel'"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"'mlFeature'"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"'application'"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"'platformResource'"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"'structuredProperty'"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"'entityType'"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"'businessAttribute'"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"'dataType'"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"'dataProduct'"),"]",", ",(0,a.yg)("inlineCode",{parentName:"li"},"Sequence"),"[",(0,a.yg)("inlineCode",{parentName:"li"},"Literal"),"[",(0,a.yg)("inlineCode",{parentName:"li"},"'erModelRelationship'"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"'dataHubSecret'"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"'dataHubPolicy'"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"'schemaField'"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"'ownershipType'"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"'telemetry'"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"'dataHubConnection'"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"'dataHubAction'"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"'corpGroup'"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"'glossaryNode'"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"'dashboard'"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"'mlModelDeployment'"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"'dataHubExecutionRequest'"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"'inviteToken'"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"'role'"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"'chart'"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"'test'"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"'dataFlow'"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"'dataPlatformInstance'"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"'form'"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"'glossaryTerm'"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"'dataHubRole'"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"'dataHubPageTemplate'"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"'dataHubUpgrade'"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"'dataHubRetention'"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"'globalSettings'"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"'corpuser'"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"'mlPrimaryKey'"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"'dataHubOpenAPISchema'"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"'assertion'"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"'mlModelGroup'"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"'dataPlatform'"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"'dataHubView'"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"'dataHubAccessToken'"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"'container'"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"'mlFeatureTable'"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"'tag'"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"'post'"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"'query'"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"'incident'"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"'dataJob'"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"'dataProcess'"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"'notebook'"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"'dataHubPersona'"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"'dataContract'"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"'dataHubStepState'"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"'dataset'"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"'dataHubPageModule'"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"'dataProcessInstance'"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"'domain'"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"'versionSet'"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"'dataHubIngestionSource'"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"'mlModel'"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"'mlFeature'"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"'application'"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"'platformResource'"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"'structuredProperty'"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"'entityType'"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"'businessAttribute'"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"'dataType'"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"'dataProduct'"),"]","]])"),(0,a.yg)("li",{parentName:"ul"},(0,a.yg)("strong",{parentName:"li"},"Return type:"),(0,a.yg)("inlineCode",{parentName:"li"},"_EntityTypeFilter"))),(0,a.yg)("h4",{id:"static-envenv-"},(0,a.yg)("em",{parentName:"h4"},"static")," env(env, /)"),(0,a.yg)("ul",null,(0,a.yg)("li",{parentName:"ul"},(0,a.yg)("strong",{parentName:"li"},"Parameters:"),(0,a.yg)("strong",{parentName:"li"},"env")," (",(0,a.yg)("inlineCode",{parentName:"li"},"Union"),"[",(0,a.yg)("inlineCode",{parentName:"li"},"str"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"Sequence"),"[",(0,a.yg)("inlineCode",{parentName:"li"},"str"),"]","])"),(0,a.yg)("li",{parentName:"ul"},(0,a.yg)("strong",{parentName:"li"},"Return type:"),(0,a.yg)("inlineCode",{parentName:"li"},"_EnvFilter"))),(0,a.yg)("h4",{id:"static-false"},(0,a.yg)("em",{parentName:"h4"},"static")," false()"),(0,a.yg)("ul",null,(0,a.yg)("li",{parentName:"ul"},(0,a.yg)("strong",{parentName:"li"},"Return type:"),(0,a.yg)("inlineCode",{parentName:"li"},"Union"),"[",(0,a.yg)("inlineCode",{parentName:"li"},"_And"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"_Or"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"_Not"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"_EntityTypeFilter"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"_EntitySubtypeFilter"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"_StatusFilter"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"_PlatformFilter"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"_DomainFilter"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"_ContainerFilter"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"_EnvFilter"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"_CustomCondition"),"]")),(0,a.yg)("h4",{id:"static-has_custom_propertykey-value"},(0,a.yg)("em",{parentName:"h4"},"static")," has_custom_property(key, value)"),(0,a.yg)("ul",null,(0,a.yg)("li",{parentName:"ul"},(0,a.yg)("strong",{parentName:"li"},"Parameters:"),(0,a.yg)("ul",{parentName:"li"},(0,a.yg)("li",{parentName:"ul"},(0,a.yg)("strong",{parentName:"li"},"key")," (",(0,a.yg)("inlineCode",{parentName:"li"},"str"),")"),(0,a.yg)("li",{parentName:"ul"},(0,a.yg)("strong",{parentName:"li"},"value")," (",(0,a.yg)("inlineCode",{parentName:"li"},"str"),")"))),(0,a.yg)("li",{parentName:"ul"},(0,a.yg)("strong",{parentName:"li"},"Return type:"),(0,a.yg)("inlineCode",{parentName:"li"},"_CustomCondition"))),(0,a.yg)("h4",{id:"static-not_arg"},(0,a.yg)("em",{parentName:"h4"},"static")," not_(arg)"),(0,a.yg)("ul",null,(0,a.yg)("li",{parentName:"ul"},(0,a.yg)("strong",{parentName:"li"},"Parameters:"),(0,a.yg)("strong",{parentName:"li"},"arg")," (",(0,a.yg)("inlineCode",{parentName:"li"},"Union"),"[",(0,a.yg)("inlineCode",{parentName:"li"},"_And"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"_Or"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"_Not"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"_EntityTypeFilter"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"_EntitySubtypeFilter"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"_StatusFilter"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"_PlatformFilter"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"_DomainFilter"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"_ContainerFilter"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"_EnvFilter"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"_CustomCondition"),"]",")"),(0,a.yg)("li",{parentName:"ul"},(0,a.yg)("strong",{parentName:"li"},"Return type:"),(0,a.yg)("inlineCode",{parentName:"li"},"_Not"))),(0,a.yg)("h4",{id:"static-or_args"},(0,a.yg)("em",{parentName:"h4"},"static")," or_(","*","args)"),(0,a.yg)("ul",null,(0,a.yg)("li",{parentName:"ul"},(0,a.yg)("strong",{parentName:"li"},"Parameters:"),(0,a.yg)("strong",{parentName:"li"},"args")," (",(0,a.yg)("inlineCode",{parentName:"li"},"Union"),"[",(0,a.yg)("inlineCode",{parentName:"li"},"_And"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"_Or"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"_Not"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"_EntityTypeFilter"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"_EntitySubtypeFilter"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"_StatusFilter"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"_PlatformFilter"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"_DomainFilter"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"_ContainerFilter"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"_EnvFilter"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"_CustomCondition"),"]",")"),(0,a.yg)("li",{parentName:"ul"},(0,a.yg)("strong",{parentName:"li"},"Return type:"),(0,a.yg)("inlineCode",{parentName:"li"},"_Or"))),(0,a.yg)("h4",{id:"static-platformplatform-"},(0,a.yg)("em",{parentName:"h4"},"static")," platform(platform, /)"),(0,a.yg)("ul",null,(0,a.yg)("li",{parentName:"ul"},(0,a.yg)("strong",{parentName:"li"},"Parameters:"),(0,a.yg)("strong",{parentName:"li"},"platform")," (",(0,a.yg)("inlineCode",{parentName:"li"},"Union"),"[",(0,a.yg)("inlineCode",{parentName:"li"},"str"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"Sequence"),"[",(0,a.yg)("inlineCode",{parentName:"li"},"str"),"]","])"),(0,a.yg)("li",{parentName:"ul"},(0,a.yg)("strong",{parentName:"li"},"Return type:"),(0,a.yg)("inlineCode",{parentName:"li"},"_PlatformFilter"))),(0,a.yg)("h4",{id:"static-soft_deletedstatus"},(0,a.yg)("em",{parentName:"h4"},"static")," soft_deleted(status)"),(0,a.yg)("ul",null,(0,a.yg)("li",{parentName:"ul"},(0,a.yg)("strong",{parentName:"li"},"Parameters:"),(0,a.yg)("strong",{parentName:"li"},"status")," (",(0,a.yg)("inlineCode",{parentName:"li"},"RemovedStatusFilter"),")"),(0,a.yg)("li",{parentName:"ul"},(0,a.yg)("strong",{parentName:"li"},"Return type:"),(0,a.yg)("inlineCode",{parentName:"li"},"_StatusFilter"))),(0,a.yg)("h4",{id:"static-true"},(0,a.yg)("em",{parentName:"h4"},"static")," true()"),(0,a.yg)("ul",null,(0,a.yg)("li",{parentName:"ul"},(0,a.yg)("strong",{parentName:"li"},"Return type:"),(0,a.yg)("inlineCode",{parentName:"li"},"Union"),"[",(0,a.yg)("inlineCode",{parentName:"li"},"_And"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"_Or"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"_Not"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"_EntityTypeFilter"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"_EntitySubtypeFilter"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"_StatusFilter"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"_PlatformFilter"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"_DomainFilter"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"_ContainerFilter"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"_EnvFilter"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"_CustomCondition"),"]"))),(0,a.yg)("h3",{id:"datahub.sdk.search_filters.load_filters"},(0,a.yg)("span",{className:"visually-hidden"},"load_filters")),(0,a.yg)("div",{className:"h3-block"},(0,a.yg)("div",{className:"section-heading"},(0,a.yg)("span",{class:"class-owner"},"datahub.sdk.search_filters."),(0,a.yg)("span",{class:"class-name"},"load_filters"),"(",(0,a.yg)("span",{class:"arg-name"},"obj"),")",(0,a.yg)("a",{href:"#datahub.sdk.search_filters.load_filters",class:"hash-link"})),(0,a.yg)("ul",null,(0,a.yg)("li",{parentName:"ul"},(0,a.yg)("strong",{parentName:"li"},"Parameters:"),(0,a.yg)("strong",{parentName:"li"},"obj")," (",(0,a.yg)("inlineCode",{parentName:"li"},"Any"),")"),(0,a.yg)("li",{parentName:"ul"},(0,a.yg)("strong",{parentName:"li"},"Return type:"),(0,a.yg)("inlineCode",{parentName:"li"},"Union"),"[",(0,a.yg)("inlineCode",{parentName:"li"},"_And"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"_Or"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"_Not"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"_EntityTypeFilter"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"_EntitySubtypeFilter"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"_StatusFilter"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"_PlatformFilter"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"_DomainFilter"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"_ContainerFilter"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"_EnvFilter"),", ",(0,a.yg)("inlineCode",{parentName:"li"},"_CustomCondition"),"]")))))}N.isMDXComponent=!0}}]);
Reference in New Issue View Git Blame Copy Permalink