pyapacheatlas.core.discovery.purview.PurviewDiscoveryClient.query#

PurviewDiscoveryClient.query(keywords=None, filter=None, facets=None, taxonomySetting=None, api_version='2022-03-01-preview', **kwargs)#

Execute a search query against Azure Purview’s /catalog/api/search/query endpoint.

Parameters

  • body (dict) – An optional fully formed json body. If provided, all other params will be ignored except api-version.

  • keywords (str) – The keyword to search. You can use None or ‘*’ for wildcard, or a string to 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.

  • limit (int) – The number of search results to return.

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

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

Returns

Search query results with @search.count and value fields.

Return type

dict