Type Alias LineageGraphsAPI

type LineageGraphsAPI = {
    clearCache: typeof clearCache;
    createLineageGraphNodeOverview: typeof createLineageGraphNodeOverview;
    expandLineageGraphImpact: typeof expandLineageGraphImpact;
    expandLineageGraphNode: typeof expandLineageGraphNode;
    getLineageGraphImpactOverview: typeof getLineageGraphImpactOverview;
    getLineageGraphImpactSource: typeof getLineageGraphImpactSource;
    getLineageGraphNode: typeof getLineageGraphNode;
    searchLineageGraphImpact: typeof searchLineageGraphImpact;
    searchLineageGraphNode: typeof searchLineageGraphNode;
}
Index

Properties

clearCache createLineageGraphNodeOverview expandLineageGraphImpact expandLineageGraphNode getLineageGraphImpactOverview getLineageGraphImpactSource getLineageGraphNode searchLineageGraphImpact searchLineageGraphNode

Properties

clearCache: typeof clearCache

Clears the cache for lineage-graphs api requests.

createLineageGraphNodeOverview: typeof createLineageGraphNodeOverview

Returns the first generation upstream direct lineage. For each field QRI, will find any direct linege dataset or application.

The qri for root node.

an object with query parameters

Param: body

an object with the body content

CreateLineageGraphNodeOverviewHttpError

expandLineageGraphImpact: typeof expandLineageGraphImpact

Returns next-level nodes inside a specified node on an impact analysis graph retrieved using a base node.

The QRI for base node.

an object with query parameters

ExpandLineageGraphImpactHttpError

expandLineageGraphNode: typeof expandLineageGraphNode

Returns the expanded node and its edges. Up and downstream nodes are not part of the response, edges are. The id is the root node that lineage is requested for. The QRI of the node to expand is sent as the query parameter "node" for expansion.

The id (QRI) for the source node.

an object with query parameters

ExpandLineageGraphNodeHttpError

getLineageGraphImpactOverview: typeof getLineageGraphImpactOverview

Returns all RESOURCE level nodes that are impacted by a change in the source node. The number of tables and fields that are impacted for each resource are included as metadata. The id (QRI) can be on any level (FIELD, TABLE or RESOURCE) and the impact will be collected based on the starting QRI.

The qri for root node.

an object with query parameters

GetLineageGraphImpactOverviewHttpError

getLineageGraphImpactSource: typeof getLineageGraphImpactSource

Returns all levels of the requested root node. Only node information will be returned.

getLineageGraphImpactSource(
  "qri:app:sense://e5c651d5-1198-45a2-be5d-f016cee0baf5"
)

The id (QRI) for root node.

GetLineageGraphImpactSourceHttpError

getLineageGraphNode: typeof getLineageGraphNode

Returns lineage graphs for requested levels of a source node. The id (QRI) can point to an item on the field, table and resource level.

The id (QRI) for the source node.

an object with query parameters

GetLineageGraphNodeHttpError

searchLineageGraphImpact: typeof searchLineageGraphImpact

Search all labels within a impact graph on all available levels. Returns result per level

searchLineageGraphImpact(
  "qri:app:sense://e5c651d5-1198-45a2-be5d-f016cee0baf5",
  {
    filter: "label co \"label1\" or label co \"label2\""
  }
)

The qri for root node.

an object with query parameters

SearchLineageGraphImpactHttpError

searchLineageGraphNode: typeof searchLineageGraphNode

Search all labels within a lineage graph on all available levels. Returns result per level.

searchLineageGraphNode(
  "qri:app:sense://e5c651d5-1198-45a2-be5d-f016cee0baf5",
  {
    filter: "label co \"label1\" or label co \"label2\""
  }
)

The qri for root node.

an object with query parameters

SearchLineageGraphNodeHttpError

Settings

Member Visibility

On This Page

Properties