lineage

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

Overview

Name	lineage
Type	Resource
Id	azure.purview_data_map.lineage

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
baseEntityGuid	string	The GUID of the base entity.
childrenCount	integer	The number of children node.
guidEntityMap	object	The GUID entity map.
lineageDepth	integer	The depth of lineage.
lineageDirection	string	The enum of lineage direction. Known values are: "INPUT", "OUTPUT", and "BOTH". (INPUT, OUTPUT, BOTH)
lineageWidth	integer	The width of lineage.
parentRelations	array	An array of parentRelations relations.
relations	array	An array of lineage relations.
widthCounts	object	The entity count in specific direction.

get_by_unique_attribute

Name	Datatype	Description
baseEntityGuid	string	The GUID of the base entity.
childrenCount	integer	The number of children node.
guidEntityMap	object	The GUID entity map.
lineageDepth	integer	The depth of lineage.
lineageDirection	string	The enum of lineage direction. Known values are: "INPUT", "OUTPUT", and "BOTH". (INPUT, OUTPUT, BOTH)
lineageWidth	integer	The width of lineage.
parentRelations	array	An array of parentRelations relations.
relations	array	An array of lineage relations.
widthCounts	object	The entity count in specific direction.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	guid, direction, endpoint	depth	Get lineage info of the entity specified by GUID.
get_by_unique_attribute	select	type_name, direction, endpoint	depth, attr:qualifiedName	Return 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. The REST request would look something like this: GET /v2/lineage/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.
get_next_page	exec	guid, direction, endpoint	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: "INPUT", "OUTPUT", and "BOTH". Required.
endpoint	string	The service endpoint host (no scheme), e.g. myaccount.table.cosmos.azure.com:443 - value of the client endpoint parameter. (default: )
guid	string	The globally unique identifier of the entity. Required.
type_name	string	The name of the type. Required.
attr:qualifiedName	string	The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes). Default value is None.
depth	integer	The number of hops for lineage. 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.

SELECT examples

get

Get lineage info of the entity specified by GUID.

SELECT
baseEntityGuid,
childrenCount,
guidEntityMap,
lineageDepth,
lineageDirection,
lineageWidth,
parentRelations,
relations,
widthCounts
FROM azure.purview_data_map.lineage
WHERE guid = '{{ guid }}' -- required
AND direction = '{{ direction }}' -- required
AND endpoint = '{{ endpoint }}' -- required
AND depth = '{{ depth }}'
;

get_by_unique_attribute

Return 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. The REST request would look something like this: GET /v2/lineage/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.

SELECT
baseEntityGuid,
childrenCount,
guidEntityMap,
lineageDepth,
lineageDirection,
lineageWidth,
parentRelations,
relations,
widthCounts
FROM azure.purview_data_map.lineage
WHERE type_name = '{{ type_name }}' -- required
AND direction = '{{ direction }}' -- required
AND endpoint = '{{ endpoint }}' -- required
AND depth = '{{ depth }}'
AND attr:qualifiedName = '{{ attr:qualifiedName }}'
;

Lifecycle Methods

get_next_page

Return immediate next page lineage info about entity with pagination.

EXEC azure.purview_data_map.lineage.get_next_page 
@guid='{{ guid }}' --required, 
@direction='{{ direction }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@offset='{{ offset }}', 
@limit='{{ limit }}'
;