pyapacheatlas.core.discovery.purview.PurviewDiscoveryClient.search_entities#

PurviewDiscoveryClient.search_entities(query, limit=50, search_filter=None, starting_offset=0, api_version='2022-03-01-preview', **kwargs)#

Search entities based on a query and automatically handles limits and offsets to page through results.

The limit provides how many records are returned in each batch with a maximum of 1,000 entries per page.

Parameters

  • query (str) – The search query to be executed.

  • limit (int) – A non-zero integer representing how many entities to return for each page of the search results.

  • search_filter (dict) – A json object that includes and, not, or conditions and ultimately a dict that contains attributeName, operator, and attributeValue.

  • facets (dict) – The kind of aggregate count you want to retrieve. Should be a dict that contains fields: count, facet, and sort.

  • taxonomySetting (dict) – Undocumented.

  • offset (int) – The number of search results to skip.

  • api_version (str) – The Purview API version to use.

Kwargs:
kwarg dict body

An optional fully formed json body. If provided

query/keywords, limit, search_filter/filter, and starting_offset/offset will be updated using the values found in the body dictionary. Any additional keys provided in body will be passed along as additional kwargs.

Returns

The results of your search as a generator.

Return type

Iterator(dict)