Add a lineage edge between two entities to represent data flow, transformation dependencies, or upstream/downstream relationships using the Collate REST API for impact analysis.
PUT
/
v1
/
lineage
PUT /v1/lineage
from metadata.generated.schema.entity.data.table import Tablefrom metadata.generated.schema.type.entityReference import EntityReferencefrom metadata.generated.schema.api.lineage.addLineage import AddLineageRequestfrom metadata.generated.schema.type.entityLineage import ( ColumnLineage, EntitiesEdge, LineageDetails,)from metadata.ingestion.ometa.ometa_api import OpenMetadatafrom metadata.generated.schema.entity.services.connections.metadata.openMetadataConnection import ( OpenMetadataConnection,)from metadata.generated.schema.security.client.openMetadataJWTClientConfig import ( OpenMetadataJWTClientConfig,)server_config = OpenMetadataConnection( hostPort="https://your-company.getcollate.io/api", authProvider="openmetadata", securityConfig=OpenMetadataJWTClientConfig( jwtToken="<YOUR-JWT-TOKEN>" ),)metadata = OpenMetadata(server_config)# Simple lineage between two tablesadd_lineage_request = AddLineageRequest( edge=EntitiesEdge( description="ETL transformation", fromEntity=EntityReference(id=source_table.id, type="table"), toEntity=EntityReference(id=target_table.id, type="table"), ),)created_lineage = metadata.add_lineage(data=add_lineage_request)# With column-level lineage and SQL querycolumn_lineage = ColumnLineage( fromColumns=["service.db.schema.source_table.customer_id"], toColumn="service.db.schema.target_table.cust_id",)lineage_details = LineageDetails( sqlQuery="INSERT INTO target_table SELECT customer_id FROM source_table", columnsLineage=[column_lineage], pipeline=EntityReference(id=pipeline_entity.id, type="pipeline"),)add_lineage_request = AddLineageRequest( edge=EntitiesEdge( fromEntity=EntityReference(id=source_table.id, type="table"), toEntity=EntityReference(id=target_table.id, type="table"), lineageDetails=lineage_details, ),)created_lineage = metadata.add_lineage(data=add_lineage_request)# Automated SQL lineage (parses SQL to extract lineage)from metadata.generated.schema.entity.services.databaseService import DatabaseServicedatabase_service = metadata.get_by_name(entity=DatabaseService, fqn="my_service")metadata.add_lineage_by_query( database_service=database_service, sql="INSERT INTO target_table(id) SELECT id FROM source_table", timeout=200,)
import org.openmetadata.sdk.api.Lineage;// Simple lineage between two entitiesLineage.LineageEdge edge = Lineage.connect() .from("table", sourceTableId) .to("dashboard", dashboardId) .withDescription("Dashboard uses data from this table") .execute();// With column-level lineage, pipeline, and SQL queryLineage.LineageEdge edge = Lineage.connect() .from("table", sourceTableId) .fromColumns("customer_id", "order_date") .to("table", targetTableId) .toColumns("cust_id", "date") .withPipeline("pipeline", pipelineId) .withDescription("ETL transformation") .withSqlQuery("SELECT customer_id, order_date FROM source") .execute();
Create a lineage edge between two entities. Supports column-level lineage mappings, pipeline references, and SQL query annotations.
The Python examples on this page use the original client (metadata.ingestion.ometa.ometa_api.OpenMetadata) because SDK 2.0 (metadata.sdk) doesn’t include lineage operations. For more information, see Which Python SDK Should I Use?.
Request Body
object
required
The lineage edge to create.
Show properties
object
required
Entity reference for the lineage source.
Show properties
string
required
UUID of the source entity.
string
required
Entity type (e.g., table, dashboard, pipeline, topic).
object
required
Entity reference for the lineage destination.
Show properties
string
required
UUID of the destination entity.
string
required
Entity type (e.g., table, dashboard, pipeline, topic).
string
Description of the lineage relationship.
object
Optional details for the lineage edge.
Show properties
string
SQL query driving the transformation.
array
Column-level lineage mappings.
Show properties
array
List of source column fully qualified names.
string
Destination column fully qualified name.
object
Entity reference for the pipeline powering the transformation.
Show properties
string
required
UUID of the pipeline entity.
string
required
Must be pipeline.
PUT /v1/lineage
from metadata.generated.schema.entity.data.table import Tablefrom metadata.generated.schema.type.entityReference import EntityReferencefrom metadata.generated.schema.api.lineage.addLineage import AddLineageRequestfrom metadata.generated.schema.type.entityLineage import ( ColumnLineage, EntitiesEdge, LineageDetails,)from metadata.ingestion.ometa.ometa_api import OpenMetadatafrom metadata.generated.schema.entity.services.connections.metadata.openMetadataConnection import ( OpenMetadataConnection,)from metadata.generated.schema.security.client.openMetadataJWTClientConfig import ( OpenMetadataJWTClientConfig,)server_config = OpenMetadataConnection( hostPort="https://your-company.getcollate.io/api", authProvider="openmetadata", securityConfig=OpenMetadataJWTClientConfig( jwtToken="<YOUR-JWT-TOKEN>" ),)metadata = OpenMetadata(server_config)# Simple lineage between two tablesadd_lineage_request = AddLineageRequest( edge=EntitiesEdge( description="ETL transformation", fromEntity=EntityReference(id=source_table.id, type="table"), toEntity=EntityReference(id=target_table.id, type="table"), ),)created_lineage = metadata.add_lineage(data=add_lineage_request)# With column-level lineage and SQL querycolumn_lineage = ColumnLineage( fromColumns=["service.db.schema.source_table.customer_id"], toColumn="service.db.schema.target_table.cust_id",)lineage_details = LineageDetails( sqlQuery="INSERT INTO target_table SELECT customer_id FROM source_table", columnsLineage=[column_lineage], pipeline=EntityReference(id=pipeline_entity.id, type="pipeline"),)add_lineage_request = AddLineageRequest( edge=EntitiesEdge( fromEntity=EntityReference(id=source_table.id, type="table"), toEntity=EntityReference(id=target_table.id, type="table"), lineageDetails=lineage_details, ),)created_lineage = metadata.add_lineage(data=add_lineage_request)# Automated SQL lineage (parses SQL to extract lineage)from metadata.generated.schema.entity.services.databaseService import DatabaseServicedatabase_service = metadata.get_by_name(entity=DatabaseService, fqn="my_service")metadata.add_lineage_by_query( database_service=database_service, sql="INSERT INTO target_table(id) SELECT id FROM source_table", timeout=200,)
import org.openmetadata.sdk.api.Lineage;// Simple lineage between two entitiesLineage.LineageEdge edge = Lineage.connect() .from("table", sourceTableId) .to("dashboard", dashboardId) .withDescription("Dashboard uses data from this table") .execute();// With column-level lineage, pipeline, and SQL queryLineage.LineageEdge edge = Lineage.connect() .from("table", sourceTableId) .fromColumns("customer_id", "order_date") .to("table", targetTableId) .toColumns("cust_id", "date") .withPipeline("pipeline", pipelineId) .withDescription("ETL transformation") .withSqlQuery("SELECT customer_id, order_date FROM source") .execute();