query

package

v0.2.0 Latest Latest Go to latest Published: Jun 7, 2026 License: MIT Imports: 7 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/dobbo-ca/graphify-go

Links

Open Source Insights

Documentation ¶

Overview ¶

Package query answers questions against a built graph.json without rebuilding: find nodes by name, explain a node and its neighbours, and find the shortest dependency path between two nodes. These back the CLI commands the Claude skill uses instead of grepping the source tree.

Index ¶

type Explanation
- func Explain(g *Graph, id string) (*Explanation, error)
type Graph
- func Load(path string) (*Graph, error)
type Link
type Match
- func Query(g *Graph, pattern string) ([]Match, error)
type Neighbor
type Node
- func Path(g *Graph, from, to string) ([]Node, error)

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Explanation ¶

type Explanation struct {
	Node      *Node
	Neighbors []Neighbor
}

Explanation is a node plus its grouped neighbours.

func Explain ¶

func Explain(g *Graph, id string) (*Explanation, error)

Explain returns a node and its neighbours, labelled by relation and direction (-> outgoing, <- incoming). id may be a full node ID or a label substring with a unique match.

type Graph ¶

type Graph struct {
	Nodes []Node `json:"nodes"`
	Links []Link `json:"links"`
	// contains filtered or unexported fields
}

Graph is a loaded graph.json.

func Load ¶

func Load(path string) (*Graph, error)

Load reads and validates a graph.json at path. The path must resolve inside a graphify-out directory and stay under the size cap.

type Link ¶

type Link struct {
	Source     string `json:"source"`
	Target     string `json:"target"`
	Relation   string `json:"relation"`
	Confidence string `json:"confidence"`
}

Link mirrors a graph.json edge.

type Match ¶

type Match struct {
	ID, Label, Location string
}

Match is a node found by Query.

func Query ¶

func Query(g *Graph, pattern string) ([]Match, error)

Query returns nodes whose id, label, or normalised label matches the given regular expression (case-insensitive). Results are sorted by label.

type Neighbor ¶

type Neighbor struct {
	ID, Label, Relation, Direction, Location string
}

Neighbor is an adjacent node in a given direction.

type Node ¶

type Node struct {
	ID             string `json:"id"`
	Label          string `json:"label"`
	FileType       string `json:"file_type"`
	SourceFile     string `json:"source_file"`
	SourceLocation string `json:"source_location"`
	Community      *int   `json:"community"`
	NormLabel      string `json:"norm_label"`
}

Node mirrors a graph.json node.

func Path ¶

func Path(g *Graph, from, to string) ([]Node, error)

Path returns the shortest path (by node labels/ids) between two nodes via BFS on the undirected graph, or an error if no path exists.

Source Files ¶

View all Source files

query.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL