lineage

Creates, updates, deletes, gets or lists a lineage resource.

Overview

Name	lineage
Type	Resource
Id	azure.purview_catalog.lineage

Fields

The following fields are returned by SELECT queries:

SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_lineage_graph	exec	guid, direction, endpoint	depth, width, includeParent, getDerivedLineage	Get lineage info of the entity specified by GUID.
get_lineage_by_unique_attribute	exec	type_name, direction, endpoint	depth, width, includeParent, getDerivedLineage	Returns lineage info about entity. In addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format attr:[attrName]=[attrValue] NOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName.
next_page_lineage	exec	guid, direction, endpoint	getDerivedLineage, offset, limit	Return immediate next page lineage info about entity with pagination.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
direction	string	The direction of the lineage, which could be INPUT, OUTPUT or BOTH. Known values are: "BOTH", "INPUT", and "OUTPUT".
endpoint	string	The service endpoint host (no scheme). (default: )
guid	string	The globally unique identifier of the entity.
type_name	string	The name of the type.
depth	integer	The number of hops for lineage. Default value is 3.
getDerivedLineage	boolean	True to include derived lineage in the response. Default value is None.
includeParent	boolean	True to include the parent chain in the response. Default value is None.
limit	integer	The page size - by default there is no paging. Default value is None.
offset	integer	The offset for pagination purpose. Default value is None.
width	integer	The number of max expanding width in lineage. Default value is 10.

Lifecycle Methods

get_lineage_graph

Get lineage info of the entity specified by GUID.

EXEC azure.purview_catalog.lineage.get_lineage_graph 
@guid='{{ guid }}' --required, 
@direction='{{ direction }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@depth='{{ depth }}', 
@width='{{ width }}', 
@includeParent={{ includeParent }}, 
@getDerivedLineage={{ getDerivedLineage }}
;

get_lineage_by_unique_attribute

Returns lineage info about entity. In addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format attr:[attrName]=[attrValue] NOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName.

EXEC azure.purview_catalog.lineage.get_lineage_by_unique_attribute 
@type_name='{{ type_name }}' --required, 
@direction='{{ direction }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@depth='{{ depth }}', 
@width='{{ width }}', 
@includeParent={{ includeParent }}, 
@getDerivedLineage={{ getDerivedLineage }}
;

next_page_lineage

Return immediate next page lineage info about entity with pagination.

EXEC azure.purview_catalog.lineage.next_page_lineage 
@guid='{{ guid }}' --required, 
@direction='{{ direction }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@getDerivedLineage={{ getDerivedLineage }}, 
@offset='{{ offset }}', 
@limit='{{ limit }}'
;