Class LineageGraphQueryService

  • All Implemented Interfaces:
    org.odpi.openmetadata.governanceservers.openlineage.OpenLineageQueryService

    public class LineageGraphQueryService
    extends java.lang.Object
    implements org.odpi.openmetadata.governanceservers.openlineage.OpenLineageQueryService
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.util.Optional<LineageVerticesAndEdges> endToEnd​(java.lang.String guid, boolean includeProcesses)
      Returns the end to end graph of queried entity, which can be a column or a table.
      org.odpi.openmetadata.governanceservers.openlineage.responses.LineageVertexResponse getEntityDetails​(java.lang.String guid)
      org.odpi.openmetadata.governanceservers.openlineage.responses.LineageNodeNamesResponse getNodes​(NodeNamesSearchCriteria searchCriteria)
      org.odpi.openmetadata.governanceservers.openlineage.responses.LineageTypesResponse getTypes()
      org.odpi.openmetadata.governanceservers.openlineage.responses.LineageResponse lineage​(Scope scope, java.lang.String guid, boolean includeProcesses)
      org.odpi.openmetadata.governanceservers.openlineage.responses.LineageSearchResponse search​(org.odpi.openmetadata.governanceservers.openlineage.requests.LineageSearchRequest lineageSearchRequest)
      Search the database for entities matching the search request
      java.util.Optional<LineageVerticesAndEdges> ultimateDestination​(java.lang.String guid)
      Returns the ultimate destination graph of queried entity, which can be a column or a table.
      java.util.Optional<LineageVerticesAndEdges> ultimateSource​(java.lang.String guid)
      Returns the ultimate source graph of queried entity, which can be a column or a table.
      java.util.Optional<LineageVerticesAndEdges> verticalLineage​(java.lang.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 org.odpi.openmetadata.governanceservers.openlineage.responses.LineageResponse lineage​(Scope scope,
                                                                                                     java.lang.String guid,
                                                                                                     boolean includeProcesses)
        Specified by:
        lineage in interface org.odpi.openmetadata.governanceservers.openlineage.OpenLineageQueryService
      • endToEnd

        public java.util.Optional<LineageVerticesAndEdges> endToEnd​(java.lang.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 java.util.Optional<LineageVerticesAndEdges> ultimateSource​(java.lang.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 java.util.Optional<LineageVerticesAndEdges> ultimateDestination​(java.lang.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
      • getEntityDetails

        public org.odpi.openmetadata.governanceservers.openlineage.responses.LineageVertexResponse getEntityDetails​(java.lang.String guid)
        Specified by:
        getEntityDetails in interface org.odpi.openmetadata.governanceservers.openlineage.OpenLineageQueryService
      • getTypes

        public org.odpi.openmetadata.governanceservers.openlineage.responses.LineageTypesResponse getTypes()
        Specified by:
        getTypes in interface org.odpi.openmetadata.governanceservers.openlineage.OpenLineageQueryService
      • getNodes

        public org.odpi.openmetadata.governanceservers.openlineage.responses.LineageNodeNamesResponse getNodes​(NodeNamesSearchCriteria searchCriteria)
        Specified by:
        getNodes in interface org.odpi.openmetadata.governanceservers.openlineage.OpenLineageQueryService
      • search

        public org.odpi.openmetadata.governanceservers.openlineage.responses.LineageSearchResponse search​(org.odpi.openmetadata.governanceservers.openlineage.requests.LineageSearchRequest lineageSearchRequest)
        Search the database for entities matching the search request
        Specified by:
        search in interface org.odpi.openmetadata.governanceservers.openlineage.OpenLineageQueryService
        Parameters:
        lineageSearchRequest - the criteria for the search
        Returns:
        all the entities in the graph that match the criteria