| (window.webpackJsonp=window.webpackJsonp||[]).push([[37],{"./src/documents/Search/SearchBasic.md":function(e,t,i){"use strict";i.r(t),i.d(t,"default",(function(){return c}));var n=i("../node_modules/babel-preset-react-app/node_modules/@babel/runtime/helpers/esm/objectWithoutProperties.js"),a=(i("../node_modules/react/index.js"),i("../node_modules/@mdx-js/react/dist/esm.js")),s=(i("./theme/styles/styled-colors.js"),i("../node_modules/react-syntax-highlighter/dist/esm/styles/hljs/dark.js")),r=i("../node_modules/react-syntax-highlighter/dist/esm/default-highlight.js"),l=i("./theme/components/shared/Img/index.js"),o=["components"],u={};function c(e){var t=e.components,i=Object(n.a)(e,o);return Object(a.mdx)("wrapper",Object.assign({},u,i,{components:t,mdxType:"MDXLayout"}),Object(a.mdx)("h1",{id:"basic-search"},"Basic Search"),Object(a.mdx)("p",null,"The basic search allows you to query using typename of an entity, associated classification/tag and has support for filtering on the entity attribute(s) as well as the classification/tag attributes."),Object(a.mdx)("p",null,"The entire query structure can be represented using the following JSON structure (called SearchParameters)"),Object(a.mdx)(r.a,{wrapLines:!0,language:"json",style:s.a,mdxType:"SyntaxHighlighter"},'{\n "typeName": "hive_column",\n "excludeDeletedEntities": true,\n "classification": "PII",\n "query": "",\n "offset": 0,\n "limit": 25,\n "entityFilters": { },\n "tagFilters": { },\n "attributes": [ "table", "qualifiedName"]\n}'),Object(a.mdx)("p",null,Object(a.mdx)("strong",{parentName:"p"},"Field description")),Object(a.mdx)(r.a,{wrapLines:!0,language:"json",style:s.a,mdxType:"SyntaxHighlighter"},"typeName: the type of entity to look for\nexcludeDeletedEntities: should the search exclude deleted entities? (default: true)\nclassification: only include entities with given classification\nquery: any free text occurrence that the entity should have (generic/wildcard queries might be slow)\noffset: starting offset of the result set (useful for pagination)\nlimit: max number of results to fetch\nentityFilters: entity attribute filter(s)\ntagFilters: classification attribute filter(s)\nattributes: attributes to include in the search result"),Object(a.mdx)(l.a,{src:"/images/twiki/search-basic-hive_column-PII.png",height:"500",width:"840",mdxType:"Img"}),Object(a.mdx)("p",null," Attribute based filtering can be done on multiple attributes with AND/OR conditions."),Object(a.mdx)("p",null,Object(a.mdx)("strong",{parentName:"p"},"Examples of filtering (for hive_table attributes)")),Object(a.mdx)("ul",null,Object(a.mdx)("li",{parentName:"ul"},"Single attribute")),Object(a.mdx)(r.a,{wrapLines:!0,language:"json",style:s.a,mdxType:"SyntaxHighlighter"},' {\n "typeName": "hive_table",\n "excludeDeletedEntities": true,\n "offset": 0,\n "limit": 25,\n "entityFilters": {\n "attributeName": "name",\n "operator": "contains",\n "attributeValue": "customers"\n },\n "attributes": [ "db", "qualifiedName" ]\n }'),Object(a.mdx)(l.a,{src:"/images/twiki/search-basic-hive_table-customers.png",height:"500",width:"840",mdxType:"Img"}),Object(a.mdx)("ul",null,Object(a.mdx)("li",{parentName:"ul"},"Multi-attribute with OR")),Object(a.mdx)(r.a,{wrapLines:!0,language:"json",style:s.a,mdxType:"SyntaxHighlighter"},' {\n "typeName": "hive_table",\n "excludeDeletedEntities": true,\n "offset": 0,\n "limit": 25,\n "entityFilters": {\n "condition": "OR",\n "criterion": [\n {\n "attributeName": "name",\n "operator": "contains",\n "attributeValue": "customers"\n },\n {\n "attributeName": "name",\n "operator": "contains",\n "attributeValue": "provider"\n }\n ]\n },\n "attributes": [ "db", "qualifiedName" ]\n }'),Object(a.mdx)(l.a,{src:"/images/twiki/search-basic-hive_table-customers-or-provider.png",height:"500",width:"840",mdxType:"Img"}),Object(a.mdx)("ul",null,Object(a.mdx)("li",{parentName:"ul"},"Multi-attribute with AND")),Object(a.mdx)(r.a,{wrapLines:!0,language:"json",style:s.a,mdxType:"SyntaxHighlighter"},' {\n "typeName": "hive_table",\n "excludeDeletedEntities": true,\n "offset": 0,\n "limit": 25,\n "entityFilters": {\n "condition": "AND",\n "criterion": [\n {\n "attributeName": "name",\n "operator": "contains",\n "attributeValue": "customers"\n },\n {\n "attributeName": "owner",\n "operator": "eq",\n "attributeValue": "hive"\n }\n ]\n },\n "attributes": [ "db", "qualifiedName" ]\n }'),Object(a.mdx)(l.a,{src:"/images/twiki/search-basic-hive_table-customers-owner_is_hive.png",height:"500",width:"840",mdxType:"Img"}),Object(a.mdx)("p",null,Object(a.mdx)("strong",{parentName:"p"},"Supported operators for filtering")),Object(a.mdx)("ul",null,Object(a.mdx)("li",{parentName:"ul"},"LT (symbols: <, lt) works with Numeric, Date attributes"),Object(a.mdx)("li",{parentName:"ul"},"GT (symbols: >, gt) works with Numeric, Date attributes"),Object(a.mdx)("li",{parentName:"ul"},"LTE (symbols: <=, lte) works with Numeric, Date attributes"),Object(a.mdx)("li",{parentName:"ul"},"GTE (symbols: >=, gte) works with Numeric, Date attributes"),Object(a.mdx)("li",{parentName:"ul"},"EQ (symbols: eq, =) works with Numeric, Date, String attributes"),Object(a.mdx)("li",{parentName:"ul"},"NEQ (symbols: neq, !=) works with Numeric, Date, String attributes"),Object(a.mdx)("li",{parentName:"ul"},"LIKE (symbols: like, LIKE) works with String attributes"),Object(a.mdx)("li",{parentName:"ul"},"STARTS_WITH (symbols: startsWith, STARTSWITH) works with String attributes"),Object(a.mdx)("li",{parentName:"ul"},"ENDS_WITH (symbols: endsWith, ENDSWITH) works with String attributes"),Object(a.mdx)("li",{parentName:"ul"},"CONTAINS (symbols: contains, CONTAINS) works with String attributes")),Object(a.mdx)("p",null,Object(a.mdx)("strong",{parentName:"p"},"CURL Samples")),Object(a.mdx)(r.a,{wrapLines:!0,language:"shell",style:s.a,mdxType:"SyntaxHighlighter"},'curl -sivk -g\n -u <user>:<password>\n -X POST\n -d \'{\n "typeName": "hive_table",\n "excludeDeletedEntities": true,\n "classification": "",\n "query": "",\n "offset": 0,\n "limit": 50,\n "entityFilters": {\n "condition": "AND",\n "criterion": [\n {\n "attributeName": "name",\n "operator": "contains",\n "attributeValue": "customers"\n },\n {\n "attributeName": "owner",\n "operator": "eq",\n "attributeValue": "hive"\n }\n ]\n },\n "attributes": [ "db", "qualifiedName" ]\n }\'\n <protocol>://<atlas_host>:<atlas_port>/api/atlas/v2/search/basic'))}c&&c===Object(c)&&Object.isExtensible(c)&&Object.defineProperty(c,"__filemeta",{enumerable:!0,configurable:!0,value:{name:"MDXContent",filename:"src/documents/Search/SearchBasic.md"}}),c.isMDXComponent=!0},"./theme/components/shared/Img/index.js":function(e,t,i){"use strict";var n=i("../node_modules/react/index.js"),a=i("./docz-lib/docz/dist/index.js");t.a=e=>{const{src:t,width:i,height:s}=e,{baseUrl:r}=Object(a.useConfig)();return n.createElement("div",null,n.createElement("img",{style:{boxShadow:"0 2px 2px 0 rgba(0,0,0,0.14), 0 3px 1px -2px rgba(0,0,0,0.12), 0 1px 5px 0 rgba(0,0,0,0.2)",WebkitBoxShadow:"0 2px 2px 0 rgba(0,0,0,0.14) 0 3px 1px -2px rgba(0,0,0,0.12), 0 1px 5px 0 rgba(0,0,0,0.2)",MozBoxShadow:"0 2px 2px 0 rgba(0,0,0,0.14) 0 3px 1px -2px rgba(0,0,0,0.12), 0 1px 5px 0 rgba(0,0,0,0.2)"},src:`${r}${t}`,height:""+(s||"auto"),width:""+(i||"100%")}))}},"./theme/styles/styled-colors.js":function(e,t,i){"use strict";var n=i("../node_modules/react-syntax-highlighter/dist/esm/styles/hljs/dark.js");n.a.hljs.color="#37bb9b",t.a=n.a}}]); |
