Skip to main content

GraphStore

Trait GraphStore 

Source
pub trait GraphStore: Send + Sync {
Show 17 methods // Required methods fn apply_diff(&mut self, branch: &str, diff: &GraphDiff) -> Result<()>; fn lookup_symbol( &self, branch: &str, name: &str, fuzzy: bool, ) -> Result<Vec<Node>>; fn find_callers( &self, branch: &str, function_name: &str, ) -> Result<Vec<Node>>; fn find_callers_deep( &self, branch: &str, function_name: &str, depth: u8, ) -> Result<CallersDeep>; fn symbol_context(&self, branch: &str, name: &str) -> Result<SymbolContext>; fn list_definitions(&self, branch: &str, file: &Path) -> Result<Vec<Node>>; fn list_all_nodes(&self, branch: &str) -> Result<Vec<Node>>; fn list_all_edges(&self, branch: &str) -> Result<Vec<Edge>>; fn branch_diff(&self, from: &str, to: &str) -> Result<GraphDiff>; fn find_callees( &self, branch: &str, function_name: &str, depth: u8, ) -> Result<CallersDeep>; fn find_implementors( &self, branch: &str, trait_or_interface_name: &str, ) -> Result<Vec<Node>>; fn trace_path( &self, branch: &str, from: &str, to: &str, ) -> Result<Vec<Node>>; fn list_symbols_in_range( &self, branch: &str, file: &Path, start_line: u32, end_line: u32, ) -> Result<Vec<Node>>; fn find_unused_symbols( &self, branch: &str, kind: Option<NodeKind>, ) -> Result<Vec<Node>>; fn get_subgraph( &self, branch: &str, seed_name: &str, depth: u8, direction: &str, ) -> Result<SubGraph>; fn last_indexed_sha(&self, branch: &str) -> Result<Option<String>>; fn set_last_indexed_sha(&mut self, branch: &str, sha: &str) -> Result<()>;
}
Expand description

Backend-agnostic interface for the knowledge graph store.

The v0.1 implementation is KuzuGraphStore (local embedded DB). A remote backend can be plugged in by implementing this trait without touching the indexer or MCP layers.

Required Methods§

Source

fn apply_diff(&mut self, branch: &str, diff: &GraphDiff) -> Result<()>

Apply an incremental diff to the named branch’s graph.

Source

fn lookup_symbol( &self, branch: &str, name: &str, fuzzy: bool, ) -> Result<Vec<Node>>

Find all nodes matching name on branch. When fuzzy is true, matches any node whose name contains name (case-sensitive substring). When false, exact match only.

Source

fn find_callers(&self, branch: &str, function_name: &str) -> Result<Vec<Node>>

Find all call-site nodes whose outgoing Calls edge points to a node named function_name on branch (single hop).

Source

fn find_callers_deep( &self, branch: &str, function_name: &str, depth: u8, ) -> Result<CallersDeep>

Multi-hop BFS: find callers up to depth hops away. Returns callers grouped by hop distance (1..=depth). depth is capped at 5 to prevent runaway queries.

Source

fn symbol_context(&self, branch: &str, name: &str) -> Result<SymbolContext>

Return a 360° view of a symbol: its definition, direct callers, direct callees, and nodes that reference it via Uses edges.

Source

fn list_definitions(&self, branch: &str, file: &Path) -> Result<Vec<Node>>

List all top-level definitions in file on branch.

Source

fn list_all_nodes(&self, branch: &str) -> Result<Vec<Node>>

Return all nodes in branch’s graph.

Source

fn list_all_edges(&self, branch: &str) -> Result<Vec<Edge>>

Return all edges in branch’s graph.

Source

fn branch_diff(&self, from: &str, to: &str) -> Result<GraphDiff>

Return the graph delta between two branches as a GraphDiff. Nodes/edges present in to but not from are in added_*. Nodes/edges present in from but not to are in removed_*.

Source

fn find_callees( &self, branch: &str, function_name: &str, depth: u8, ) -> Result<CallersDeep>

Find all functions/methods called by function_name up to depth hops. Returns callees grouped by hop distance (1..=depth). Capped at 5.

Source

fn find_implementors( &self, branch: &str, trait_or_interface_name: &str, ) -> Result<Vec<Node>>

Find all structs/classes that implement/inherit trait_or_interface_name.

Source

fn trace_path(&self, branch: &str, from: &str, to: &str) -> Result<Vec<Node>>

Find all call paths between from and to using BFS. Returns at most one path (the shortest), as a sequence of nodes.

Source

fn list_symbols_in_range( &self, branch: &str, file: &Path, start_line: u32, end_line: u32, ) -> Result<Vec<Node>>

Find all nodes in file whose span overlaps [start_line, end_line].

Source

fn find_unused_symbols( &self, branch: &str, kind: Option<NodeKind>, ) -> Result<Vec<Node>>

Find symbols with no incoming Calls or Uses edges (potential dead code). If kind is provided, filters to only that NodeKind.

Source

fn get_subgraph( &self, branch: &str, seed_name: &str, depth: u8, direction: &str, ) -> Result<SubGraph>

Return a subgraph centred on seed_name up to depth hops. direction: “in” (callers), “out” (callees), or “both”.

Source

fn last_indexed_sha(&self, branch: &str) -> Result<Option<String>>

Last commit SHA successfully indexed for branch. None if the branch has never been indexed.

Source

fn set_last_indexed_sha(&mut self, branch: &str, sha: &str) -> Result<()>

Persist the commit SHA after a successful index run.

Implementors§