Struct MatchPlan 

pub struct MatchPlan {
    pub bindings: Vec<BindingDef>,
    pub stages: Vec<MatchStage>,
    pub output: Option<MatchOutput>,
}

The declarative plan for a single GQL MATCH query.

Invariants the lowering guarantees (the planner relies on these and never re-derives them):

• every Expr is BINDING-ROW scoped (a.x → Idiom[Field("a"),Field("x")]), with 3VL guards already inserted;
• MatchPredicate::deps is the exact set of bindings the expr reads;
• conjuncts are NNF-split and live on the clause whose pattern scope owns them (critical for OPTIONAL);
• column names are final (naming rules applied; duplicates rejected);
• ORDER BY aliases are resolved (non-DISTINCT → source exprs; DISTINCT → columns);
• repeated pattern variables are rewritten to hidden bindings + equality conjuncts; anonymous edges needing DIFFERENT-EDGES tracking have hidden bindings;
• every pattern is anchorable (rule in V2_DESIGN §0).

Fields

bindings: Vec<BindingDef>

All bindings; index equals the BindingId.

stages: Vec<MatchStage>

The query’s steps in textual order: read clauses and write stages, interleaved as written. May be empty only for a bare RETURN (rejected in lowering).

output: Option<MatchOutput>

The RETURN projection, or None for a mutation-only query (no trailing RETURN).

Implementations

impl MatchPlan

pub fn has_mutations(&self) -> bool

Whether this plan carries any write stage. Drives the transaction type (a mutation-bearing plan is not read-only, so the executor opens a write transaction) — see Expr::read_only.

impl MatchPlan

pub fn binding(&self, id: BindingId) -> &BindingDef

Look up a binding by id.

Panics

Panics if id is not a valid index into MatchPlan::bindings. Callers (the streaming planner) only ever pass ids that the lowering placed into this same plan’s bindings/patterns, so the index is always in range; an out-of-range id is an internal-consistency bug, not a user-reachable path. For the never-panicking rendering path use MatchPlan::binding_name.

Trait Implementations

impl Clone for MatchPlan

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MatchPlan

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

Formats the value using the given formatter.

impl Eq for MatchPlan

impl Hash for MatchPlan

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for MatchPlan

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for MatchPlan

impl ToSql for MatchPlan

Deterministic GQL-ish rendering of a MatchPlan.

Used by EXPLAIN, Debug-adjacent tooling, and logs: it must be stable and must never panic on any plan, well-formed or not. Predicate, column, order, and skip/limit slots delegate to Expr’s ToSql so 3VL guard shapes stay textually diffable. The rendering is single-line regardless of fmt.

fn fmt_sql(&self, f: &mut String, _fmt: SqlFormat)

Format the type to a SQL string.

fn to_sql(&self) -> String

Convert the type to a SQL string.

fn to_sql_pretty(&self) -> String

Convert the type to a pretty-printed SQL string with indentation.