Skip to main content
Version: 0.3.0

QueryVisualization

age-schema-client v0.3.0


age-schema-client / QueryVisualization

Class: QueryVisualization

Defined in: src/query/visualization.ts:185

Query visualization helper

Provides utilities for visualizing query results and execution plans

Constructors

Constructor

new QueryVisualization(): QueryVisualization;

Returns

QueryVisualization

Methods

toGraphVisualization()

static toGraphVisualization(result, options): GraphVisualizationData;

Defined in: src/query/visualization.ts:193

Convert query result to graph visualization data

Parameters

ParameterTypeDescription
resultQueryResultQuery result
optionsGraphVisualizationOptionsVisualization options

Returns

GraphVisualizationData

Graph visualization data


toDot()

static toDot(graphData, directed): string;

Defined in: src/query/visualization.ts:239

Generate a DOT language representation of a graph

Parameters

ParameterTypeDefault valueDescription
graphDataGraphVisualizationDataundefinedGraph visualization data
directedbooleantrueWhether the graph is directed

Returns

string

DOT language representation


parseQueryPlan()

static parseQueryPlan(planResult): QueryPlanNode;

Defined in: src/query/visualization.ts:290

Parse a query execution plan

Parameters

ParameterTypeDescription
planResultanyQuery execution plan result

Returns

QueryPlanNode

Parsed query plan


queryPlanToDot()

static queryPlanToDot(plan): string;

Defined in: src/query/visualization.ts:328

Generate a DOT language representation of a query plan

Parameters

ParameterTypeDescription
planQueryPlanNodeQuery plan

Returns

string

DOT language representation