Struct GraphCreateNode 

pub struct GraphCreateNode {
    pub input: Arc<LogicalPlan>,
    pub nodes: Vec<ResolvedNodeSpec>,
    pub edges: Vec<ResolvedEdgeSpec>,
    pub dir: PathBuf,
    pub mode: OntologyMode,
    /* private fields */
}

Logical node for CREATE: a write specification driven by an input plan.

Carries the resolved node/edge specs plus the project directory and ontology mode needed to drive a writer. The directory is baked in at lowering time because the physical-planning layer (an ExtensionPlanner) only sees the DataFusion session state, not the GraphForge project path.

Input

The CREATE runs once per input row (#703): a standalone CREATE (:X) lowers over the implicit single unit row (so it creates exactly once), while a mixed MATCH … CREATE … runs the write once per matched row, referencing MATCH-bound vars’ identities (ResolvedNodeSpec::is_reference) and minting the rest. The input columns are consumed (for cardinality + referenced identities), not projected — the node still emits only the write summary.

Output schema is a one-row write summary: nodes_created / edges_created (UInt64).

Fields

input: Arc<LogicalPlan>

Input plan whose rows drive the writes (the implicit unit row for a standalone CREATE; the MATCH results for a mixed pipeline).

nodes: Vec<ResolvedNodeSpec>

Nodes to create, in pattern order.

edges: Vec<ResolvedEdgeSpec>

Edges to create, in pattern order.

dir: PathBuf

Target project directory.

mode: OntologyMode

Ontology mode (drives writer edge / property routing).

Implementations

impl GraphCreateNode

pub fn summary_schema() -> Arc<Schema>

Build the write-summary Arrow schema (nodes_created, edges_created, properties_set, labels_added).

pub fn new( input: Arc<LogicalPlan>, nodes: Vec<ResolvedNodeSpec>, edges: Vec<ResolvedEdgeSpec>, dir: PathBuf, mode: OntologyMode, ) -> Self

Create a new graph-create node over input in summary mode: the node emits the one-row write summary (a terminal CREATE).

pub fn new_emitting( input: Arc<LogicalPlan>, nodes: Vec<ResolvedNodeSpec>, edges: Vec<ResolvedEdgeSpec>, dir: PathBuf, mode: OntologyMode, output_schema: DFSchemaRef, ) -> Self

Create a node in emit-rows mode (write-result RETURN, #814): instead of the summary, it emits one row per input row carrying the input columns plus the created variables’ var_<n>-qualified identity + property columns (output_schema), so a following RETURN/WITH can read them. Side effects are reported out of band (the exec’s tally), since a relation cannot also carry the summary.

pub fn emits_rows(&self) -> bool

Whether this node emits created-entity rows (true) rather than the one-row write summary (false).

Trait Implementations

impl Clone for GraphCreateNode

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 GraphCreateNode

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

Formats the value using the given formatter.

impl Eq for GraphCreateNode

impl Hash for GraphCreateNode

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 GraphCreateNode

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for GraphCreateNode

fn partial_cmp(&self, _other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl UserDefinedLogicalNodeCore for GraphCreateNode

fn name(&self) -> &str

Return the plan’s name.

fn inputs(&self) -> Vec<&LogicalPlan>

Return the logical plan’s inputs.

fn schema(&self) -> &DFSchemaRef

Return the output schema of this logical plan node.

fn expressions(&self) -> Vec<Expr>

Returns all expressions in the current logical plan node. This should not include expressions of any inputs (aka non-recursively). These expressions are used for optimizer passes and rewrites.

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

Write a single line, human readable string to f for use in explain plan.

fn with_exprs_and_inputs( &self, exprs: Vec<Expr>, inputs: Vec<LogicalPlan>, ) -> DfResult<Self>

Create a new UserDefinedLogicalNode with the specified children and expressions. This function is used during optimization when the plan is being rewritten and a new instance of the UserDefinedLogicalNode must be created.

fn check_invariants( &self, _check: InvariantLevel, ) -> Result<(), DataFusionError>

Perform check of invariants for the extension node.

fn prevent_predicate_push_down_columns(&self) -> HashSet<String>

A list of output columns (e.g. the names of columns in self.schema()) for which predicates can not be pushed below this node without changing the output.

fn necessary_children_exprs( &self, _output_columns: &[usize], ) -> Option<Vec<Vec<usize>>>

Returns the necessary input columns for this node required to compute the columns in the output schema

fn supports_limit_pushdown(&self) -> bool

Returns true if a limit can be safely pushed down through this UserDefinedLogicalNode node.