name: Basic Search route: /SearchBasic menu: Documentation submenu: Search

import themen from ‘theme/styles/styled-colors’; import * as theme from ‘react-syntax-highlighter/dist/esm/styles/hljs’; import SyntaxHighlighter from ‘react-syntax-highlighter’; import Img from ‘theme/components/shared/Img’

Basic Search

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.

The entire query structure can be represented using the following JSON structure (called SearchParameters)

Field description

<Img src={/images/twiki/search-basic-hive_column-PII.png} height=“500” width=“840”/>

Attribute based filtering can be done on multiple attributes with AND/OR conditions.

Examples of filtering (for hive_table attributes)

  • Single attribute

<Img src={/images/twiki/search-basic-hive_table-customers.png} height=“500” width=“840”/>

  • Multi-attribute with OR

<Img src={/images/twiki/search-basic-hive_table-customers-or-provider.png} height=“500” width=“840”/>

  • Multi-attribute with AND

<Img src={/images/twiki/search-basic-hive_table-customers-owner_is_hive.png} height=“500” width=“840”/>

Supported operators for filtering

  • LT (symbols: <, lt) works with Numeric, Date attributes
  • GT (symbols: >, gt) works with Numeric, Date attributes
  • LTE (symbols: <=, lte) works with Numeric, Date attributes
  • GTE (symbols: >=, gte) works with Numeric, Date attributes
  • EQ (symbols: eq, =) works with Numeric, Date, String attributes
  • NEQ (symbols: neq, !=) works with Numeric, Date, String attributes
  • LIKE (symbols: like, LIKE) works with String attributes
  • STARTS_WITH (symbols: startsWith, STARTSWITH) works with String attributes
  • ENDS_WITH (symbols: endsWith, ENDSWITH) works with String attributes
  • CONTAINS (symbols: contains, CONTAINS) works with String attributes

CURL Samples