Struct GraphPlan 

pub struct GraphPlan {
    pub source: SourceKind,
    pub sink: SinkKind,
    pub mode: PlanMode,
    pub batch_rows: usize,
    pub concurrency: usize,
    pub checkpoint: String,
    pub nodes: Vec<NodePlan>,
    pub edges: Vec<EdgePlan>,
    pub proposals: Vec<EdgeProposal>,
    pub warnings: Vec<String>,
}

The canonical rel2graph plan: the single source both projections read.

Deterministic by construction (see GraphPlan::from_mapping): tables schema-then-name, node props ordinal, nodes-before-edges, edges sorted (from_label, rel, to_label). No timestamps, no randomness, no hashmap iteration order — the same input is the same bytes, always.

Fields

source: SourceKind

Source plane.

sink: SinkKind

Graph sink.

mode: PlanMode

Batch/streaming.

batch_rows: usize

Rows per UNWIND … MERGE batch.

concurrency: usize

Writer concurrency (coalesce(N)).

checkpoint: String

The single checkpoint / storage location.

nodes: Vec<NodePlan>

Nodes, in canonical order.

edges: Vec<EdgePlan>

Edges, in canonical order.

proposals: Vec<EdgeProposal>

T4 inference proposals — emitted commented-out, never applied.

warnings: Vec<String>

Provenance + honesty notes, closing every artifact.

Implementations

impl GraphPlan

pub fn from_mapping( spec: &MappingSpec, opts: &CodegenOptions, ) -> Result<GraphPlan>

Lower a reviewed MappingSpec into the canonical plan.

Walks tables in schema-then-name order; each vertex step becomes a NodePlan, each edge/fk_edges step a EdgePlan (direction = src → dst, the child→parent FK direction). custom steps are opaque and cannot be projected to a declarative graph load, so they are SURFACED in warnings, never silently dropped.

Errors on the blocking gaps the spec names: a streaming plan on a non-Iceberg source, or a node with no merge key.

pub fn with_proposals( self, proposals: impl IntoIterator<Item = EdgeProposal>, ) -> Self

Attach T4 inference proposals (from an inclusion-dependency pass run elsewhere). They are stamped Tier::T4InclusionDependency and will only ever be emitted COMMENTED-OUT. Returns self for chaining.

pub fn contract(&self) -> String

A canonical, human-readable digest of the plan’s labels, merge keys, edge directions and batch size — the contract both projections must honour. The two-projections-agree test compares what it can parse back out of each artifact against this. Deterministic and stable.

pub fn to_pyspark(&self) -> String

Projection (a): a PySpark job loading the schema into the graph sink. Obeys the rel2graph Python hard rules: a FAIR scheduler, indexes created at startup, nodes-before-edges, the sink client constructed inside the partition function, a coalesce() before foreachPartition, and idempotent UNWIND $rows AS r MERGE in batch_rows-sized chunks. Streaming wraps the same per-partition writer in a single foreachBatch with one checkpointLocation.

Deterministic: same plan ⇒ byte-identical Python.

pub fn emit_warnings(&self, p: &mut String, line_prefix: &str)

The WARNINGS block, prefixed with line_prefix (e.g. # for Python, // for RON). Closes every artifact — provenance first, then notes.

Trait Implementations

impl Clone for GraphPlan

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 GraphPlan

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

Formats the value using the given formatter.

impl Eq for GraphPlan

impl PartialEq for GraphPlan

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for GraphPlan