Search entities

Search Query Text, Pass text for substring match; Pass without wildcards for exact match. <br/> 1. For listing all tables or topics pass q=* <br/>2. For search tables or topics pass q=search_term <br/>3. For searching field names such as search by columnNames pass q=columnNames:address , for searching deleted entities, use q=deleted:true <br/> 4. For searching by tag names pass q=tags.tagFQN:user.email <br/>5. When user selects a filter pass q=query_text AND q=tags.tagFQN:user.email AND platform:MYSQL <br/>6. Search with multiple values of same filter q=tags.tagFQN:user.email AND tags.tagFQN:user.address <br/> 7. Search by service version and type q=service.type:databaseService AND version:0.1 <br/> 8. Search Tables with Specific Constraints q=tableConstraints.constraintType.keyword:PRIMARY_KEY AND NOT tier.tagFQN:Tier.Tier1 <br/> 9. Search with owners q=owner.displayName.keyword:owner_name <br/> NOTE: logic operators such as AND, OR and NOT must be in uppercase

ElasticSearch Index name, defaults to table_search_index

Filter documents by deleted param. By default deleted is false

From field to paginate the results, defaults to 0

Size field to limit the no.of results returned, defaults to 10

Pagination cursor. Repeat once per sort value: ?search_after=v1&search_after=v2. Each value carried as its own parameter so values containing ',' (e.g. a glossary term FQN) are safe.

Sort the search results by field, available fields to sort weekly_stats , daily_stats, monthly_stats, last_updated_timestamp

Sort order asc for ascending or desc for descending, defaults to desc

Track Total Hits

Elasticsearch query that will be combined with the query_string query generator from the query argument

Elasticsearch query that will be used as a post_filter

Get document body for each hit

Get only selected fields of the document body for each hit. Empty value will return all fields

Exclude specified fields from the document body for each hit. Use this to exclude heavy fields like 'columns' for better performance

Fetch search results in hierarchical order of children elements. By default hierarchy is not fetched. Currently only supported for glossary_term_search_index.

Explain the results of the query. Defaults to false. Only for debugging purposes.

Include aggregations in the search response. Defaults to true. Set to false to skip aggregations for faster response times when only search results are needed.