blob: 28b83f9f6cbb29cc7bd88482ca53dd79c0d12687 [file] [log] [blame]
{"version":3,"sources":["/home/madhan/Apache/git/atlas/docs/target/src/documents/Search/SearchBasic.md","/home/madhan/Apache/git/atlas/docs/target/theme/components/shared/Img/index.js","/home/madhan/Apache/git/atlas/docs/target/theme/styles/styled-colors.js"],"names":["layoutProps","MDXContent","components","props","mdxType","wrapLines","language","style","theme","parentName","src","height","width","isMDXComponent","Img","baseUrl","useConfig","boxShadow","WebkitBoxShadow","MozBoxShadow","dark","hljs","color"],"mappings":"2nBAYMA,EAAc,GAIL,SAASC,EAAW,GAG/B,IAFFC,EAAU,EAAVA,WACGC,EAAK,iBAER,OAAO,cALS,UAKC,iBAAKH,EAAiBG,EAAK,CAAED,WAAYA,EAAYE,QAAQ,cAE5E,oBACE,GAAM,gBAAc,gBAEtB,iOACA,qIACA,cAAC,IAAiB,CAACC,WAAW,EAAMC,SAAS,OAAOC,MAAOC,IAAYJ,QAAQ,qBAAmB,2VAalG,uBAAG,wBAAQK,WAAW,KAAG,sBAC5B,cAAC,IAAiB,CAACJ,WAAW,EAAMC,SAAS,OAAOC,MAAOC,IAAYJ,QAAQ,qBAAmB,8oBAW/F,cAAC,IAAG,CAACM,IAAG,iDAAoDC,OAAO,MAAMC,MAAM,MAAMR,QAAQ,QAC7F,kHACA,uBAAG,wBAAQK,WAAW,KAAG,sDACzB,wBACE,oBAAIA,WAAW,MAAI,qBAErB,cAAC,IAAiB,CAACJ,WAAW,EAAMC,SAAS,OAAOC,MAAOC,IAAYJ,QAAQ,qBAAmB,0WAclG,cAAC,IAAG,CAACM,IAAG,sDAAyDC,OAAO,MAAMC,MAAM,MAAMR,QAAQ,QAClG,wBACE,oBAAIK,WAAW,MAAI,4BAErB,cAAC,IAAiB,CAACJ,WAAW,EAAMC,SAAS,OAAOC,MAAOC,IAAYJ,QAAQ,qBAAmB,snBAwBlG,cAAC,IAAG,CAACM,IAAG,kEAAqEC,OAAO,MAAMC,MAAM,MAAMR,QAAQ,QAC9G,wBACE,oBAAIK,WAAW,MAAI,6BAErB,cAAC,IAAiB,CAACJ,WAAW,EAAMC,SAAS,OAAOC,MAAOC,IAAYJ,QAAQ,qBAAmB,6mBAwBlG,cAAC,IAAG,CAACM,IAAG,oEAAuEC,OAAO,MAAMC,MAAM,MAAMR,QAAQ,QAChH,uBAAG,wBAAQK,WAAW,KAAG,sCACzB,wBACE,oBAAIA,WAAW,MAAI,2DACnB,oBAAIA,WAAW,MAAI,2DACnB,oBAAIA,WAAW,MAAI,8DACnB,oBAAIA,WAAW,MAAI,8DACnB,oBAAIA,WAAW,MAAI,mEACnB,oBAAIA,WAAW,MAAI,sEACnB,oBAAIA,WAAW,MAAI,2DACnB,oBAAIA,WAAW,MAAI,8EACnB,oBAAIA,WAAW,MAAI,wEACnB,oBAAIA,WAAW,MAAI,wEAErB,uBAAG,wBAAQA,WAAW,KAAG,iBACzB,cAAC,IAAiB,CAACJ,WAAW,EAAMC,SAAS,QAAQC,MAAOC,IAAYJ,QAAQ,qBAAmB,49BA+BtG,yLAEDH,EAAWY,gBAAiB,G,sEChL5B,+EAuCeC,IAnBHX,IACX,MAAM,IAAEO,EAAG,MAAEE,EAAK,OAAED,GAAWR,GACzB,QAAEY,GAAYC,sBAMpB,OACC,2BACC,uBAC6BT,MART,CACtBU,UAAW,6FACIC,gBAAiB,4FACjBC,aAAc,6FAM1BT,IAAM,GAAEK,IAAUL,IAClBC,OAAS,IAAEA,GAAU,QACrBC,MAAQ,IAAEA,GAAS,a,+DClCvB,iFAqBAQ,IAAKC,KAAKC,MAAQ,UACHF,MAAI","file":"static/js/documents-search-search-basic.a24095d8.js","sourcesContent":["\nimport React from 'react'\nimport { mdx } from '@mdx-js/react'\n\n/* @jsxRuntime classic */\n/* @jsx mdx */\nimport themen from 'theme/styles/styled-colors';\nimport * as theme from 'react-syntax-highlighter/dist/esm/styles/hljs';\nimport SyntaxHighlighter from 'react-syntax-highlighter';\nimport Img from 'theme/components/shared/Img'\n\n\nconst layoutProps = {\n \n};\nconst MDXLayout = \"wrapper\"\nexport default function MDXContent({\n components,\n ...props\n}) {\n return <MDXLayout {...layoutProps} {...props} components={components} mdxType=\"MDXLayout\">\n\n <h1 {...{\n \"id\": \"basic-search\"\n }}>{`Basic Search`}</h1>\n <p>{`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.`}</p>\n <p>{`The entire query structure can be represented using the following JSON structure (called SearchParameters)`}</p>\n <SyntaxHighlighter wrapLines={true} language=\"json\" style={theme.dark} mdxType=\"SyntaxHighlighter\">\n {`{\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}`}\n </SyntaxHighlighter>\n <p><strong parentName=\"p\">{`Field description`}</strong></p>\n <SyntaxHighlighter wrapLines={true} language=\"json\" style={theme.dark} mdxType=\"SyntaxHighlighter\">\n {`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`}\n </SyntaxHighlighter>\n <Img src={`/images/twiki/search-basic-hive_column-PII.png`} height=\"500\" width=\"840\" mdxType=\"Img\" />\n <p>{` Attribute based filtering can be done on multiple attributes with AND/OR conditions.`}</p>\n <p><strong parentName=\"p\">{`Examples of filtering (for hive_table attributes)`}</strong></p>\n <ul>\n <li parentName=\"ul\">{`Single attribute`}</li>\n </ul>\n <SyntaxHighlighter wrapLines={true} language=\"json\" style={theme.dark} mdxType=\"SyntaxHighlighter\">\n {` {\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 }`}\n </SyntaxHighlighter>\n <Img src={`/images/twiki/search-basic-hive_table-customers.png`} height=\"500\" width=\"840\" mdxType=\"Img\" />\n <ul>\n <li parentName=\"ul\">{`Multi-attribute with OR`}</li>\n </ul>\n <SyntaxHighlighter wrapLines={true} language=\"json\" style={theme.dark} mdxType=\"SyntaxHighlighter\">\n {` {\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 }`}\n </SyntaxHighlighter>\n <Img src={`/images/twiki/search-basic-hive_table-customers-or-provider.png`} height=\"500\" width=\"840\" mdxType=\"Img\" />\n <ul>\n <li parentName=\"ul\">{`Multi-attribute with AND`}</li>\n </ul>\n <SyntaxHighlighter wrapLines={true} language=\"json\" style={theme.dark} mdxType=\"SyntaxHighlighter\">\n {` {\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 }`}\n </SyntaxHighlighter>\n <Img src={`/images/twiki/search-basic-hive_table-customers-owner_is_hive.png`} height=\"500\" width=\"840\" mdxType=\"Img\" />\n <p><strong parentName=\"p\">{`Supported operators for filtering`}</strong></p>\n <ul>\n <li parentName=\"ul\">{`LT (symbols: <, lt) works with Numeric, Date attributes`}</li>\n <li parentName=\"ul\">{`GT (symbols: >, gt) works with Numeric, Date attributes`}</li>\n <li parentName=\"ul\">{`LTE (symbols: <=, lte) works with Numeric, Date attributes`}</li>\n <li parentName=\"ul\">{`GTE (symbols: >=, gte) works with Numeric, Date attributes`}</li>\n <li parentName=\"ul\">{`EQ (symbols: eq, =) works with Numeric, Date, String attributes`}</li>\n <li parentName=\"ul\">{`NEQ (symbols: neq, !=) works with Numeric, Date, String attributes`}</li>\n <li parentName=\"ul\">{`LIKE (symbols: like, LIKE) works with String attributes`}</li>\n <li parentName=\"ul\">{`STARTS_WITH (symbols: startsWith, STARTSWITH) works with String attributes`}</li>\n <li parentName=\"ul\">{`ENDS_WITH (symbols: endsWith, ENDSWITH) works with String attributes`}</li>\n <li parentName=\"ul\">{`CONTAINS (symbols: contains, CONTAINS) works with String attributes`}</li>\n </ul>\n <p><strong parentName=\"p\">{`CURL Samples`}</strong></p>\n <SyntaxHighlighter wrapLines={true} language=\"shell\" style={theme.dark} mdxType=\"SyntaxHighlighter\">\n {`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`}\n </SyntaxHighlighter>\n </MDXLayout>;\n}\n;\nMDXContent.isMDXComponent = true;","/**\n * Licensed to the Apache Software Foundation (ASF) under one\n * or more contributor license agreements. See the NOTICE file\n * distributed with this work for additional information\n * regarding copyright ownership. The ASF licenses this file\n * to you under the Apache License, Version 2.0 (the\n * \"License\"); you may not use this file except in compliance\n * with the License. You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport * as React from \"react\";\nimport { useConfig } from \"../../../../docz-lib/docz/dist\";\nconst Img = props => {\n\tconst { src, width, height } = props;\n\tconst { baseUrl } = useConfig();\n const styles = {\n\tboxShadow: \"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)\",\n 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)\",\n 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)\"\n }\n\treturn (\n\t\t<div>\n\t\t\t<img\n style={styles}\n\t\t\t\tsrc={`${baseUrl}${src}`}\n\t\t\t\theight={`${height || \"auto\"}`}\n\t\t\t\twidth={`${width || \"100%\"}`}\n\t\t\t/>\n\t\t</div>\n\t);\n};\nexport default Img;\n","/**\n * Licensed to the Apache Software Foundation (ASF) under one\n * or more contributor license agreements. See the NOTICE file\n * distributed with this work for additional information\n * regarding copyright ownership. The ASF licenses this file\n * to you under the Apache License, Version 2.0 (the\n * \"License\"); you may not use this file except in compliance\n * with the License. You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { dark } from \"react-syntax-highlighter/dist/esm/styles/hljs\";\n\n//dark[\"powershell\"][\"color\"] = \"#37bb9b\";\ndark.hljs.color = \"#37bb9b\";\nexport default dark;"],"sourceRoot":""}