Struct SchemaGraph 

pub struct SchemaGraph { /* private fields */ }

A semantic graph of SurrealQL schema definitions.

Built from .surql files, provides fast lookups for tables, fields, functions, and their relationships.

Implementations

impl SchemaGraph

pub fn from_source(input: &str) -> Result<Self>

Build a schema graph from a SurrealQL string.

pub fn from_files(dir: &Path) -> Result<Self>

Build a schema graph by walking all .surql files in a directory.

Source locations are tracked per file for go-to-definition support.

pub fn from_files_per_file(dir: &Path) -> Result<HashMap<PathBuf, Self>>

Build per-file schema graphs by walking all .surql files in a directory.

Returns a map from file path to its individual SchemaGraph. Used for incremental rebuilding: on save, only the changed file is re-parsed, then all per-file graphs are merged.

pub fn from_single_file(path: &Path) -> Option<Self>

Build a schema graph from a single .surql file.

Returns None if the file cannot be read or parsed.

pub fn attach_source_locations(&mut self, source: &str, file: &Path)

Scan source text via the lexer for DEFINE statement positions.

pub fn merge(&mut self, other: SchemaGraph)

Merge another schema graph into this one.

Fields, indexes, and events are deduplicated by name. SCHEMAFULL wins over SCHEMALESS (once a table is marked SCHEMAFULL, it stays).

pub fn from_definitions(defs: &SchemaDefinitions) -> Self

pub fn scoped(&self, ns: Option<&str>, db: Option<&str>) -> Self

Return a filtered schema containing only tables matching the given NS/DB scope. Tables with no NS/DB (None) are included in all scopes (default context).

pub fn table_names(&self) -> impl Iterator<Item = &str>

Iterate over all table names in the schema.

pub fn table(&self, name: &str) -> Option<&TableDef>

Get table definition by name.

pub fn fields_of(&self, table: &str) -> &[FieldDef]

Fields defined on a table.

pub fn indexes_of(&self, table: &str) -> &[IndexDef]

Indexes defined on a table.

pub fn events_of(&self, table: &str) -> &[EventDef]

Events defined on a table.

pub fn function(&self, name: &str) -> Option<&FunctionDef>

Get function definition by name (without the fn:: prefix).

pub fn function_names(&self) -> impl Iterator<Item = &str>

Iterate over all function names (without fn:: prefix).

pub fn param_names(&self) -> impl Iterator<Item = &str>

Iterate over all defined param names.

pub fn find_field(&self, field_name: &str) -> Vec<(&str, &FieldDef)>

Find a field by name across all tables. Returns (table_name, field_def).

Uses a pre-built HashMap index for O(1) lookup by field name, instead of scanning all tables.

pub fn field_on(&self, table: &str, field_name: &str) -> Option<&FieldDef>

Find a field on a specific table.

pub fn tables_reachable_from( &self, start: &str, max_depth: usize, ) -> Vec<(String, usize, Vec<String>)>

Tables reachable from start within max_depth hops via record<> links.

Uses BFS with cycle detection. Returns (table_name, depth, path) where path is the chain of table.field segments traversed to reach each table.

The starting table itself is not included in the results.

pub fn tables_referencing(&self, target: &str) -> Vec<(String, String)>

Tables that reference target via record<target> fields (reverse dependencies).

Returns (referencing_table, field_name) pairs. Useful for answering: “What would break if I drop or rename this table?”

pub fn siblings_of(&self, table: &str) -> Vec<(String, String, String)>

Tables that share a common record<> target with table (siblings).

Answers: “Which other tables also link to the same targets as this table?” Returns (sibling_table, shared_target, via_field) triples.

pub fn dependency_tree(&self, root: &str, max_depth: usize) -> DependencyNode

Build a full dependency tree rooted at root, following record<> links.

Cycles are detected: if a table appears as its own ancestor, the node is marked with is_cycle = true and has no children (the recursion stops).

A max_nodes safety cap (1000) prevents exponential blowup on diamond-shaped graphs where the same table is reachable through many paths.

pub fn build_graph_tree_markdown(&self) -> String

Generate a markdown graph tree for all tables in the schema.

Builds a dependency tree for each table and formats it as an indented markdown tree view. Used by the LSP to cache graph.md.

pub fn build_docs_markdown(&self) -> String

Generate markdown documentation from schema definitions.

Includes tables with fields (type, default, comment), indexes, events, and function signatures with parameters and return types.

Trait Implementations

impl Clone for SchemaGraph

fn clone(&self) -> SchemaGraph

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SchemaGraph

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for SchemaGraph

fn default() -> SchemaGraph

Returns the “default value” for a type.