MCE Builder

These classes and methods make it easier to construct MetadataChangeEvents.

Convenience functions for creating MCEs

OwnerType

class datahub.emitter.mce_builder.OwnerType(value)

Bases: Enum

An enumeration.

GROUP = 'corpGroup'

USER = 'corpuser'

assert_can_add_aspect

datahub.emitter.mce_builder.assert_can_add_aspect(mce, AspectType)

• Parameters:
  • mce (MetadataChangeEventClass) –
  • AspectType (Type[TypeVar(Aspect, bound= _Aspect)]) –
• Return type:None

assertion_urn_to_key

datahub.emitter.mce_builder.assertion_urn_to_key(assertion_urn)

• Parameters:assertion_urn (str)
• Return type:Optional[AssertionKeyClass]

can_add_aspect

datahub.emitter.mce_builder.can_add_aspect(mce, AspectType)

• Parameters:
  • mce (MetadataChangeEventClass) –
  • AspectType (Type[TypeVar(Aspect, bound= _Aspect)]) –
• Return type:bool

can_add_aspect_to_snapshot

datahub.emitter.mce_builder.can_add_aspect_to_snapshot(SnapshotType, AspectType)

• Parameters:
  • SnapshotType (Type[DictWrapper])
  • AspectType (Type[TypeVar(Aspect, bound= _Aspect)]) –
• Return type:bool

chart_urn_to_key

datahub.emitter.mce_builder.chart_urn_to_key(chart_urn)

• Parameters:chart_urn (str)
• Return type:Optional[ChartKeyClass]

container_urn_to_key

datahub.emitter.mce_builder.container_urn_to_key(guid)

• Parameters:guid (str)
• Return type:Optional[ContainerKeyClass]

dashboard_urn_to_key

datahub.emitter.mce_builder.dashboard_urn_to_key(dashboard_urn)

• Parameters:dashboard_urn (str)
• Return type:Optional[DashboardKeyClass]

datahub_guid

datahub.emitter.mce_builder.datahub_guid(obj)

• Parameters:obj (dict)
• Return type:str

dataset_key_to_urn

datahub.emitter.mce_builder.dataset_key_to_urn(key)

• Parameters:key (DatasetKeyClass) –
• Return type:str

dataset_urn_to_key

datahub.emitter.mce_builder.dataset_urn_to_key(dataset_urn)

• Parameters:dataset_urn (str)
• Return type:Optional[DatasetKeyClass]

get_aspect_if_available

datahub.emitter.mce_builder.get_aspect_if_available(mce, AspectType)

• Parameters:
  • mce (MetadataChangeEventClass) –
  • AspectType (Type[TypeVar(Aspect, bound= _Aspect)]) –
• Return type:Optional[TypeVar(Aspect, bound= _Aspect)]

get_or_add_aspect

datahub.emitter.mce_builder.get_or_add_aspect(mce, default)

• Parameters:
  • mce (MetadataChangeEventClass) –
  • default (TypeVar(Aspect, bound= _Aspect)) –
• Return type:TypeVar(Aspect, bound= _Aspect)

get_sys_time

datahub.emitter.mce_builder.get_sys_time()

• Return type:int

make_assertion_urn

datahub.emitter.mce_builder.make_assertion_urn(assertion_id)

• Parameters:assertion_id (str)
• Return type:str

make_chart_urn

datahub.emitter.mce_builder.make_chart_urn(platform, name, platform_instance = None)

• Parameters:
  • platform (str)
  • name (str)
  • platform_instance (Optional[str])
• Return type:str

make_container_urn

datahub.emitter.mce_builder.make_container_urn(guid)

• Parameters:guid (Union[str, DatahubKey]) –
• Return type:str

make_dashboard_urn

datahub.emitter.mce_builder.make_dashboard_urn(platform, name, platform_instance = None)

• Parameters:
  • platform (str)
  • name (str)
  • platform_instance (Optional[str])
• Return type:str

make_data_flow_urn

datahub.emitter.mce_builder.make_data_flow_urn(orchestrator, flow_id, cluster = 'prod', platform_instance = None)

• Parameters:
  • orchestrator (str)
  • flow_id (str)
  • cluster (str)
  • platform_instance (Optional[str])
• Return type:str

make_data_job_urn

datahub.emitter.mce_builder.make_data_job_urn(orchestrator, flow_id, job_id, cluster = 'prod', platform_instance = None)

• Parameters:
  • orchestrator (str)
  • flow_id (str)
  • job_id (str)
  • cluster (str)
  • platform_instance (Optional[str])
• Return type:str

make_data_job_urn_with_flow

datahub.emitter.mce_builder.make_data_job_urn_with_flow(flow_urn, job_id)

• Parameters:
  • flow_urn (str)
  • job_id (str)
• Return type:str

make_data_platform_urn

datahub.emitter.mce_builder.make_data_platform_urn(platform)

• Parameters:platform (str)
• Return type:str

make_data_process_instance_urn

datahub.emitter.mce_builder.make_data_process_instance_urn(dataProcessInstanceId)

• Parameters:dataProcessInstanceId (str)
• Return type:str

make_dataplatform_instance_urn

datahub.emitter.mce_builder.make_dataplatform_instance_urn(platform, instance)

• Parameters:
  • platform (str)
  • instance (str)
• Return type:str

make_dataset_urn

datahub.emitter.mce_builder.make_dataset_urn(platform, name, env = 'PROD')

• Parameters:
  • platform (str)
  • name (str)
  • env (str)
• Return type:str

make_dataset_urn_with_platform_instance

datahub.emitter.mce_builder.make_dataset_urn_with_platform_instance(platform, name, platform_instance, env = 'PROD')

• Parameters:
  • platform (str)
  • name (str)
  • platform_instance (Optional[str])
  • env (str)
• Return type:str

make_domain_urn

datahub.emitter.mce_builder.make_domain_urn(domain)

• Parameters:domain (str)
• Return type:str

make_global_tag_aspect_with_tag_list

datahub.emitter.mce_builder.make_global_tag_aspect_with_tag_list(tags)

• Parameters:tags (List[str])
• Return type:GlobalTagsClass

make_glossary_terms_aspect_from_urn_list

datahub.emitter.mce_builder.make_glossary_terms_aspect_from_urn_list(term_urns)

• Parameters:term_urns (List[str])
• Return type:GlossaryTermsClass

make_group_urn

datahub.emitter.mce_builder.make_group_urn(groupname)

Makes a group urn if the input is not a user or group urn already

• Parameters:groupname (str)
• Return type:str

make_lineage_mce

datahub.emitter.mce_builder.make_lineage_mce(upstream_urns, downstream_urn, lineage_type = 'TRANSFORMED')

Note: this function only supports lineage for dataset aspects. It will not update lineage for any other aspect types.

• Parameters:
  • upstream_urns (List[str])
  • downstream_urn (str)
  • lineage_type (str)
• Return type:MetadataChangeEventClass

make_ml_feature_table_urn

datahub.emitter.mce_builder.make_ml_feature_table_urn(platform, feature_table_name)

• Parameters:
  • platform (str)
  • feature_table_name (str)
• Return type:str

make_ml_feature_urn

datahub.emitter.mce_builder.make_ml_feature_urn(feature_table_name, feature_name)

• Parameters:
  • feature_table_name (str)
  • feature_name (str)
• Return type:str

make_ml_model_deployment_urn

datahub.emitter.mce_builder.make_ml_model_deployment_urn(platform, deployment_name, env)

• Parameters:
  • platform (str)
  • deployment_name (str)
  • env (str)
• Return type:str

make_ml_model_group_urn

datahub.emitter.mce_builder.make_ml_model_group_urn(platform, group_name, env)

• Parameters:
  • platform (str)
  • group_name (str)
  • env (str)
• Return type:str

make_ml_model_urn

datahub.emitter.mce_builder.make_ml_model_urn(platform, model_name, env)

• Parameters:
  • platform (str)
  • model_name (str)
  • env (str)
• Return type:str

make_ml_primary_key_urn

datahub.emitter.mce_builder.make_ml_primary_key_urn(feature_table_name, primary_key_name)

• Parameters:
  • feature_table_name (str)
  • primary_key_name (str)
• Return type:str

make_owner_urn

datahub.emitter.mce_builder.make_owner_urn(owner, owner_type)

• Parameters:
  • owner (str)
  • owner_type (OwnerType) –
• Return type:str

make_ownership_aspect_from_urn_list

datahub.emitter.mce_builder.make_ownership_aspect_from_urn_list(owner_urns, source_type, owner_type = 'DATAOWNER')

• Parameters:
  • owner_urns (List[str])
  • source_type (Union[str, OwnershipSourceTypeClass, None]) –
  • owner_type (Union[str, OwnershipTypeClass]) –
• Return type:OwnershipClass

make_ownership_type_urn

datahub.emitter.mce_builder.make_ownership_type_urn(type)

• Parameters:type (str)
• Return type:str

make_schema_field_urn

datahub.emitter.mce_builder.make_schema_field_urn(parent_urn, field_path)

• Parameters:
  • parent_urn (str)
  • field_path (str)
• Return type:str

make_tag_urn

datahub.emitter.mce_builder.make_tag_urn(tag)

Makes a tag urn if the input is not a tag urn already

• Parameters:tag (str)
• Return type:str

make_term_urn

datahub.emitter.mce_builder.make_term_urn(term)

Makes a term urn if the input is not a term urn already

• Parameters:term (str)
• Return type:str

make_ts_millis

datahub.emitter.mce_builder.make_ts_millis(ts)

• Parameters:ts (Optional[datetime])
• Return type:Optional[int]

make_user_urn

datahub.emitter.mce_builder.make_user_urn(username)

Makes a user urn if the input is not a user or group urn already

• Parameters:username (str)
• Return type:str

parse_ts_millis

datahub.emitter.mce_builder.parse_ts_millis(ts)

• Parameters:ts (Optional[float])
• Return type:Optional[datetime]

remove_aspect_if_available

datahub.emitter.mce_builder.remove_aspect_if_available(mce, aspect_type)

• Parameters:
  • mce (MetadataChangeEventClass) –
  • aspect_type (Type[TypeVar(Aspect, bound= _Aspect)]) –
• Return type:bool

schema_field_urn_to_key

datahub.emitter.mce_builder.schema_field_urn_to_key(schema_field_urn)

• Parameters:schema_field_urn (str)
• Return type:Optional[SchemaFieldKeyClass]

set_aspect

datahub.emitter.mce_builder.set_aspect(mce, aspect, aspect_type)

Sets the aspect to the provided aspect, overwriting any previous aspect value that might have existed before. If passed in aspect is None, then the existing aspect value will be removed

• Parameters:
  • mce (MetadataChangeEventClass) –
  • aspect (Optional[TypeVar(Aspect, bound= _Aspect)]) –
  • aspect_type (Type[TypeVar(Aspect, bound= _Aspect)]) –
• Return type:None

set_dataset_urn_to_lower

datahub.emitter.mce_builder.set_dataset_urn_to_lower(value)

• Parameters:value (bool)
• Return type:None

validate_ownership_type

datahub.emitter.mce_builder.validate_ownership_type(ownership_type)

• Parameters:ownership_type (str)
• Return type:Tuple[str, Optional[str]]