Package org.odpi.openmetadata.openconnectors.governancedaemonconnectors.openlineageconnectors.janusconnector.graph

Class LineageGraphQueryService

java.lang.Object

org.odpi.openmetadata.openconnectors.governancedaemonconnectors.openlineageconnectors.janusconnector.graph.LineageGraphQueryService

All Implemented Interfaces:

OpenLineageQueryService

public class LineageGraphQueryService
extends Object
implements OpenLineageQueryService

Constructor Summary

Constructors

Constructor	Description
LineageGraphQueryService(GraphHelper graphHelper, AuditLog auditLog)

Method Summary

Modifier and Type	Method	Description
Optional<LineageVerticesAndEdges>	endToEnd(String guid, boolean includeProcesses)	Returns the end to end graph of queried entity, which can be a column or a table.
LineageVertexResponse	getEntityDetails(String guid)
LineageNodeNamesResponse	getNodes(NodeNamesSearchCriteria searchCriteria)
LineageTypesResponse	getTypes()
LineageResponse	lineage(Scope scope, String guid, boolean includeProcesses)
LineageSearchResponse	search(LineageSearchRequest lineageSearchRequest)	Search the database for entities matching the search request
Optional<LineageVerticesAndEdges>	ultimateDestination(String guid)	Returns the ultimate destination graph of queried entity, which can be a column or a table.
Optional<LineageVerticesAndEdges>	ultimateSource(String guid)	Returns the ultimate source graph of queried entity, which can be a column or a table.
Optional<LineageVerticesAndEdges>	verticalLineage(String guid)	Returns a subgraph navigating the edges of interest based on target node type.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LineageGraphQueryService

public LineageGraphQueryService(GraphHelper graphHelper,
                                AuditLog auditLog)

Method Detail

lineage

public LineageResponse lineage(Scope scope,
                               String guid,
                               boolean includeProcesses)

Specified by:

lineage in interface OpenLineageQueryService

endToEnd

public Optional<LineageVerticesAndEdges> endToEnd(String guid,
                                                  boolean includeProcesses)

Returns the end to end graph of queried entity, which can be a column or a table. In case of tables, relationships of type LineageMapping will be traversed backwards and forwards, all the way to the source and the destination, respectively. If no vertices are found, than DataFlow relationships are used for traversal. In case of columns, DataFlow relationships are directly used

Parameters:

guid - queried entity

includeProcesses - include processes

Returns:

graph in an Open Lineage specific format

ultimateSource

public Optional<LineageVerticesAndEdges> ultimateSource(String guid)

Returns the ultimate source graph of queried entity, which can be a column or a table. In case of tables, relationships of type LineageMapping will be traversed backwards, all the way to the source. If no vertices are found, than DataFlow relationships are used for traversal. In case of columns, DataFlow relationships are directly used

Parameters:

guid - queried entity

Returns:

graph in an Open Lineage specific format

ultimateDestination

public Optional<LineageVerticesAndEdges> ultimateDestination(String guid)

Returns the ultimate destination graph of queried entity, which can be a column or a table. In case of tables, relationships of type LineageMapping will be traversed forwards, all the way to the destination. If no vertices are found, than DataFlow relationships are used for traversal. In case of columns, DataFlow relationships are directly used

Parameters:

guid - queried entity

Returns:

graph in an Open Lineage specific format

verticalLineage

public Optional<LineageVerticesAndEdges> verticalLineage(String guid)

Returns a subgraph navigating the edges of interest based on target node type. For more info, check glossaryTermVerticalLineage(org.apache.tinkerpop.gremlin.process.traversal.dsl.graph.GraphTraversalSource, java.lang.String), tabularColumnVerticalLineage(org.apache.tinkerpop.gremlin.process.traversal.dsl.graph.GraphTraversalSource, java.lang.String), relationalColumnVerticalLineage(org.apache.tinkerpop.gremlin.process.traversal.dsl.graph.GraphTraversalSource, java.lang.String)

Parameters:

guid - guid to extract vertical lineage for

Returns:

a subgraph in an Open Lineage specific format

getEntityDetails

public LineageVertexResponse getEntityDetails(String guid)

Specified by:

getEntityDetails in interface OpenLineageQueryService

getTypes

public LineageTypesResponse getTypes()

Specified by:

getTypes in interface OpenLineageQueryService

getNodes

public LineageNodeNamesResponse getNodes(NodeNamesSearchCriteria searchCriteria)

Specified by:

getNodes in interface OpenLineageQueryService

search

public LineageSearchResponse search(LineageSearchRequest lineageSearchRequest)

Search the database for entities matching the search request

Specified by:

search in interface OpenLineageQueryService

Parameters:

lineageSearchRequest - the criteria for the search

Returns:

all the entities in the graph that match the criteria