Struct QueryPlanner 

pub struct QueryPlanner { /* private fields */ }

Translates a parsed Cypher AST into a LogicalPlan.

QueryPlanner applies semantic validation (variable scoping, label resolution, type checking) and produces a plan tree that the executor can run against storage.

Implementations

impl QueryPlanner

pub fn new(schema: Arc<Schema>) -> Self

Create a new planner for the given schema.

Pre-parses all generation expressions defined in the schema so that repeated plan calls avoid redundant parsing.

pub fn with_params(self, params: HashMap<String, Value>) -> Self

Set query parameters for resolving $param references in SKIP/LIMIT.

pub fn plan(&self, query: Query) -> Result<LogicalPlan>

Plan a Cypher query with no pre-bound variables.

pub fn plan_with_scope( &self, query: Query, vars: Vec<String>, ) -> Result<LogicalPlan>

Plan a Cypher query with a set of externally pre-bound variable names.

vars lists variable names already in scope before this query executes (e.g., from an enclosing Locy rule body).

pub fn plan_pattern( &self, pattern: &Pattern, initial_vars: &[VariableInfo], ) -> Result<LogicalPlan>

Plan a MATCH pattern into a LogicalPlan (Scan → Traverse chains).

This is a public entry point for the Locy plan builder to reuse the existing pattern-planning logic for clause bodies.

pub fn properties_to_expr( &self, variable: &str, properties: &Option<Expr>, ) -> Option<Expr>

pub fn node_filter_expr( &self, variable: &str, labels: &[String], properties: &Option<Expr>, ) -> Option<Expr>

Build a filter expression from node properties and labels.

This is used for TraverseMainByType where we need to filter target nodes by both labels and properties. Label checks use hasLabel(variable, ‘label’).

impl QueryPlanner

pub fn explain_plan(&self, ast: Query) -> Result<ExplainOutput>

Plan a query and produce an EXPLAIN report (plan text, index usage, costs).

pub fn explain_logical_plan(&self, plan: &LogicalPlan) -> Result<ExplainOutput>

Produce an EXPLAIN report for an already-planned logical plan.

Trait Implementations

impl Debug for QueryPlanner

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

Formats the value using the given formatter.