
* DOCS - Prepare 1.7 Release and 1.8 SNAPSHOT * DOCS - Prepare 1.7 Release and 1.8 SNAPSHOT
3.5 KiB
title | slug |
---|---|
Lineage Mixin | /sdk/python/api-reference/lineage-mixin |
module lineage_mixin
Mixin class containing Lineage specific methods
To be used by OpenMetadata class
Global Variables
- LINEAGE_PARSING_TIMEOUT
class OMetaLineageMixin
OpenMetadata API methods related to Lineage.
To be inherited by OpenMetadata
method add_lineage
add_lineage(data: AddLineageRequest) → Dict[str, Any]
Add lineage relationship between two entities and returns the entity information of the origin node
method add_lineage_by_query
add_lineage_by_query(
database_service: DatabaseService,
sql: str,
database_name: str = None,
schema_name: str = None,
timeout: int = 10
) → None
Method parses the query and generated the lineage between source and target tables
method delete_lineage_edge
delete_lineage_edge(edge: EntitiesEdge) → None
Remove the given Edge
method get_lineage_by_id
get_lineage_by_id(
entity: Union[Type[~T], str],
entity_id: str,
up_depth: int = 1,
down_depth: int = 1
) → Optional[Dict[str, Any]]
Get lineage details for an entity id
:param entity: Type of the entity :param entity_id: Entity ID :param up_depth: Upstream depth of lineage (default=1, min=0, max=3)" :param down_depth: Downstream depth of lineage (default=1, min=0, max=3)
method get_lineage_by_name
get_lineage_by_name(
entity: Union[Type[~T], str],
fqn: str,
up_depth: int = 1,
down_depth: int = 1
) → Optional[Dict[str, Any]]
Get lineage details for an entity id
:param entity: Type of the entity :param fqn: Entity FQN :param up_depth: Upstream depth of lineage (default=1, min=0, max=3)" :param down_depth: Downstream depth of lineage (default=1, min=0, max=3)