Struct PlanNode 

pub struct PlanNode { /* private fields */ }

A small bootstrap plan node used by both logical and physical plans.

Implementations

impl PlanNode

pub fn new( id: impl Into<String>, label: impl Into<String>, kind: ExecutionKind, ) -> Self

Create a node with no inputs and default annotations.

pub fn with_inputs( self, inputs: impl IntoIterator<Item = impl Into<String>>, ) -> Self

Attach input node ids to this node.

pub fn with_label(self, label: impl Into<String>) -> Self

Replace the human-readable node label.

pub fn with_partitioning(self, partitioning: Partitioning) -> Self

Set the output partitioning strategy for this node.

pub fn with_broadcast_eligible(self, broadcast_eligible: bool) -> Self

Set whether this node is eligible for broadcast join optimisation.

pub fn with_exchange( self, key_columns: impl IntoIterator<Item = impl Into<String>>, num_partitions: u32, ) -> Self

Attach an exchange (repartition) node to the plan.

This is a convenience wrapper around with_partitioning that creates a Hash partitioning on the given key columns with num_partitions buckets. Used by the DataFrame::repartition() API.

pub fn with_estimated_rows(self, estimated_rows: Option<u64>) -> Self

Set the estimated output row count for this node.

pub fn with_op(self, op: NodeOp) -> Self

Set the typed operator classification for this node.

pub fn with_output_schema(self, schema: PlanSchema) -> Self

Set the output schema for this node.

pub fn id(&self) -> &str

Stable node id inside a plan.

pub fn label(&self) -> &str

Human-readable node label.

pub fn kind(&self) -> ExecutionKind

Execution kind for this node.

pub fn inputs(&self) -> &[String]

Input node ids.

pub fn partitioning(&self) -> &Partitioning

Output partitioning strategy.

pub fn set_partitioning(&mut self, partitioning: Partitioning)

Mutate the output partitioning strategy in-place.

pub fn broadcast_eligible(&self) -> bool

Whether this node is eligible for broadcast join optimisation.

pub fn estimated_rows(&self) -> Option<u64>

Estimated output row count.

pub fn op(&self) -> Option<&NodeOp>

Typed operator classification, if set.

pub fn output_schema(&self) -> &PlanSchema

Output schema for this node.

Trait Implementations

impl Clone for PlanNode

fn clone(&self) -> PlanNode

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PlanNode

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PlanNode

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for PlanNode

impl PartialEq for PlanNode

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for PlanNode

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for PlanNode