Skip to main content
Version: Next

Search Client

The DataHub Search Client provides a client for searching and retrieving metadata from DataHub.

If you’re looking for higher-level introduction to searching using the SDK, see the search guide.

​

class datahub.sdk.search_client.SearchClient(client)

Bases: object

get_urns(query=None, filter=None)​

  • Parameters:
    • query (Optional[str])
    • filter (Union[_And, _Or, _Not, _EntityTypeFilter, _EntitySubtypeFilter, _StatusFilter, _PlatformFilter, _DomainFilter, _EnvFilter, _CustomCondition, None])
  • Return type:Iterable[Urn]

​

datahub.sdk.search_client.compile_filters(filter)
  • Parameters:filter (Union[_And, _Or, _Not, _EntityTypeFilter, _EntitySubtypeFilter, _StatusFilter, _PlatformFilter, _DomainFilter, _EnvFilter, _CustomCondition, None])
  • Return type:Tuple[Optional[List[str]], List[Dict[Literal['and'], List[Dict[str, Union[str, bool, List[str]]]]]]]

​

datahub.sdk.search_client.compute_entity_types(filters)
  • Parameters:filters (List[_AndSearchFilterRule])
  • Return type:Optional[List[str]]

​

class datahub.sdk.search_filters.FilterDsl()

Bases: object

static and_(*args)​

  • Parameters:args (Union[_And, _Or, _Not, _EntityTypeFilter, _EntitySubtypeFilter, _StatusFilter, _PlatformFilter, _DomainFilter, _EnvFilter, _CustomCondition])
  • Return type:_And

static custom_filter(field, condition, values)​

  • Parameters:
    • field (str)
    • condition (Literal['CONTAIN', 'EQUAL', 'IEQUAL', 'IN', 'EXISTS', 'GREATER_THAN', 'GREATER_THAN_OR_EQUAL_TO', 'LESS_THAN', 'LESS_THAN_OR_EQUAL_TO', 'START_WITH', 'END_WITH', 'DESCENDANTS_INCL', 'ANCESTORS_INCL', 'RELATED_INCL'])
    • values (Sequence[str])
  • Return type:_CustomCondition

static domain(domain, /)​

  • Parameters:domain (Union[str, Sequence[str]])
  • Return type:_DomainFilter

static entity_subtype(entity_subtype)​

  • Parameters:entity_subtype (Union[str, Sequence[str]])
  • Return type:_EntitySubtypeFilter

static entity_type(entity_type)​

  • Parameters:entity_type (Union[Literal['dataProduct', 'dataType', 'platformResource', 'entityType', 'structuredProperty', 'businessAttribute', 'application', 'mlFeature', 'dataContract', 'dataHubConnection', 'form', 'dataHubStepState', 'schemaField', 'dataJob', 'glossaryNode', 'notebook', 'mlModelDeployment', 'post', 'dataHubAccessToken', 'globalSettings', 'query', 'erModelRelationship', 'mlPrimaryKey', 'glossaryTerm', 'dataHubPageTemplate', 'corpGroup', 'mlModelGroup', 'incident', 'dataProcess', 'container', 'dataHubView', 'dataHubRetention', 'versionSet', 'tag', 'dataHubPageModule', 'dataHubRole', 'dashboard', 'dataFlow', 'test', 'dataHubIngestionSource', 'assertion', 'telemetry', 'mlModel', 'dataHubSecret', 'dataHubOpenAPISchema', 'dataset', 'dataHubPersona', 'dataHubExecutionRequest', 'domain', 'corpuser', 'dataProcessInstance', 'dataHubUpgrade', 'chart', 'dataHubPolicy', 'mlFeatureTable', 'dataPlatform', 'inviteToken', 'dataPlatformInstance', 'dataHubAction', 'role', 'ownershipType'], Sequence[Literal['dataProduct', 'dataType', 'platformResource', 'entityType', 'structuredProperty', 'businessAttribute', 'application', 'mlFeature', 'dataContract', 'dataHubConnection', 'form', 'dataHubStepState', 'schemaField', 'dataJob', 'glossaryNode', 'notebook', 'mlModelDeployment', 'post', 'dataHubAccessToken', 'globalSettings', 'query', 'erModelRelationship', 'mlPrimaryKey', 'glossaryTerm', 'dataHubPageTemplate', 'corpGroup', 'mlModelGroup', 'incident', 'dataProcess', 'container', 'dataHubView', 'dataHubRetention', 'versionSet', 'tag', 'dataHubPageModule', 'dataHubRole', 'dashboard', 'dataFlow', 'test', 'dataHubIngestionSource', 'assertion', 'telemetry', 'mlModel', 'dataHubSecret', 'dataHubOpenAPISchema', 'dataset', 'dataHubPersona', 'dataHubExecutionRequest', 'domain', 'corpuser', 'dataProcessInstance', 'dataHubUpgrade', 'chart', 'dataHubPolicy', 'mlFeatureTable', 'dataPlatform', 'inviteToken', 'dataPlatformInstance', 'dataHubAction', 'role', 'ownershipType']]])
  • Return type:_EntityTypeFilter

static env(env, /)​

  • Parameters:env (Union[str, Sequence[str]])
  • Return type:_EnvFilter

static false()​

  • Return type:Union[_And, _Or, _Not, _EntityTypeFilter, _EntitySubtypeFilter, _StatusFilter, _PlatformFilter, _DomainFilter, _EnvFilter, _CustomCondition]

static has_custom_property(key, value)​

  • Parameters:
    • key (str)
    • value (str)
  • Return type:_CustomCondition

static not_(arg)​

  • Parameters:arg (Union[_And, _Or, _Not, _EntityTypeFilter, _EntitySubtypeFilter, _StatusFilter, _PlatformFilter, _DomainFilter, _EnvFilter, _CustomCondition])
  • Return type:_Not

static or_(*args)​

  • Parameters:args (Union[_And, _Or, _Not, _EntityTypeFilter, _EntitySubtypeFilter, _StatusFilter, _PlatformFilter, _DomainFilter, _EnvFilter, _CustomCondition])
  • Return type:_Or

static platform(platform, /)​

  • Parameters:platform (Union[str, Sequence[str]])
  • Return type:_PlatformFilter

static soft_deleted(status)​

  • Parameters:status (RemovedStatusFilter)
  • Return type:_StatusFilter

static true()​

  • Return type:Union[_And, _Or, _Not, _EntityTypeFilter, _EntitySubtypeFilter, _StatusFilter, _PlatformFilter, _DomainFilter, _EnvFilter, _CustomCondition]

​

datahub.sdk.search_filters.load_filters(obj)
  • Parameters:obj (Any)
  • Return type:Union[_And, _Or, _Not, _EntityTypeFilter, _EntitySubtypeFilter, _StatusFilter, _PlatformFilter, _DomainFilter, _EnvFilter, _CustomCondition]