Skip to main content

ExpandNode

Struct ExpandNode 

Source
pub struct ExpandNode {
    pub input: Arc<LogicalPlan>,
    pub rel_type_name: String,
    pub src_var: u32,
    pub dst_var: u32,
    pub edge_var: u32,
    pub direction: Direction,
    pub rel_ty: Option<u32>,
    pub dir: PathBuf,
    pub mode: OntologyMode,
    pub edge_prop_count: usize,
    /* private fields */
}
Expand description

Physical node for adjacency-backed single-hop expansion (#763).

Emitted by the lowerer instead of the two-join chain whenever a project read target is available. The physical ExpandExec (graphforge-exec) probes the session adjacency provider per frontier row; that provider owns the hit/miss/building fallback policy, so plan shape is stable across index state and downstream LIMIT can cancel traversal work (#1248).

§Output schema (join-path parity)

Exactly what the join chain would have produced, in the same order: the input’s qualified fields, then the edge topology fields (typed or exploratory/wildcard) qualified var_<edge_var>, then persisted edge-property fields (forced nullable — the join path LEFT-joins them) also under var_<edge_var>, then the destination node’s topology fields qualified var_<dst_var>. Destination type filtering and property joining stay downstream in the binder’s trailing NodeScan{dst, ty} (#789), exactly as on the join path.

For Undirected, ExpandExec collapses the provider’s duplicate self-loop entries per input row, matching the relational union shape.

Fields§

§input: Arc<LogicalPlan>

Input plan (the source node scan / prior pipeline).

§rel_type_name: String

Name of the relation type to expand along ("*" for wildcard).

§src_var: u32

Source node pattern-variable id (the frontier seed in the input).

§dst_var: u32

Destination node pattern-variable id (bound to the reached node).

§edge_var: u32

Edge pattern-variable id (bound per-column, like the join path).

§direction: Direction

Edge traversal direction.

§rel_ty: Option<u32>

Resolved relation type id (TypeId.0), absent for wildcard expansion.

§dir: PathBuf

Project directory the physical node reads from.

§mode: OntologyMode

Ontology mode controlling the persisted edge layout.

§edge_prop_count: usize

How many of the var_<edge_var> fields are edge-property columns (the trailing ones); the rest are edge topology columns.

Implementations§

Source§

impl ExpandNode

Source

pub fn new( input: Arc<LogicalPlan>, rel_type_name: impl Into<String>, src_var: u32, dst_var: u32, edge_var: u32, direction: Direction, rel_ty: Option<u32>, dir: PathBuf, mode: OntologyMode, edge_fields: Vec<Arc<Field>>, edge_prop_fields: Vec<Arc<Field>>, dst_fields: Vec<Arc<Field>>, ) -> Self

Create an adjacency-backed single-hop expand node.

edge_fields are the typed edge table’s topology columns and edge_prop_fields the relation’s persisted property columns (the lowerer discovers them from edge_properties/<REL>.parquet and forces them nullable); dst_fields are the destination node’s topology columns. Passed in so this crate need not depend on graphforge-storage.

Trait Implementations§

Source§

impl Clone for ExpandNode

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ExpandNode

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for ExpandNode

Source§

impl Hash for ExpandNode

Source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for ExpandNode

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl PartialOrd for ExpandNode

Source§

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

This method returns an ordering between self and other values if one exists. Read more
1.0.0 (const: unstable) · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 (const: unstable) · Source§

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

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

impl StructuralPartialEq for ExpandNode

Source§

impl UserDefinedLogicalNodeCore for ExpandNode

Source§

fn name(&self) -> &str

Return the plan’s name.
Source§

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

Return the logical plan’s inputs.
Source§

fn schema(&self) -> &DFSchemaRef

Return the output schema of this logical plan node.
Source§

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.
Source§

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

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

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. Read more
Source§

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

Perform check of invariants for the extension node. Read more
Source§

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. Read more
Source§

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 Read more
Source§

fn supports_limit_pushdown(&self) -> bool

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

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DynEq for T
where T: Eq + Any,

Source§

fn dyn_eq(&self, other: &(dyn Any + 'static)) -> bool

Source§

impl<T> DynHash for T
where T: Hash + Any,

Source§

fn dyn_hash(&self, state: &mut dyn Hasher)

Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> UserDefinedLogicalNode for T

Source§

fn as_any(&self) -> &(dyn Any + 'static)

Return a reference to self as Any, to support dynamic downcasting Read more
Source§

fn name(&self) -> &str

Return the plan’s name.
Source§

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

Return the logical plan’s inputs.
Source§

fn schema(&self) -> &Arc<DFSchema> ⓘ

Return the output schema of this logical plan node.
Source§

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

Perform check of invariants for the extension node.
Source§

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). Read more
Source§

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. Read more
Source§

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

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

fn with_exprs_and_inputs( &self, exprs: Vec<Expr>, inputs: Vec<LogicalPlan>, ) -> Result<Arc<dyn UserDefinedLogicalNode>, DataFusionError>

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. Read more
Source§

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 Read more
Source§

fn dyn_hash(&self, state: &mut dyn Hasher)

Update the hash state with this node requirements from Hash. Read more
Source§

fn dyn_eq(&self, other: &dyn UserDefinedLogicalNode) -> bool

Compare other, respecting requirements from Eq. Read more
Source§

fn dyn_ord(&self, other: &dyn UserDefinedLogicalNode) -> Option<Ordering>

Compare other, respecting requirements from PartialOrd. Must return Some(Equal) if and only if self.dyn_eq(other).
Source§

fn supports_limit_pushdown(&self) -> bool

Returns true if a limit can be safely pushed down through this UserDefinedLogicalNode node. Read more
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V