Struct datafusion::physical_plan::hash_join::HashJoinExec

pub struct HashJoinExec { /* private fields */ }

Join execution plan executes partitions in parallel and combines them into a set of partitions.

Filter expression expected to contain non-equality predicates that can not be pushed down to any of join inputs. In case of outer join, filter applied to only matched rows.

Implementations

impl HashJoinExec

pub fn try_new(
    left: Arc<dyn ExecutionPlan>,
    right: Arc<dyn ExecutionPlan>,
    on: JoinOn,
    filter: Option<JoinFilter>,
    join_type: &JoinType,
    partition_mode: PartitionMode,
    null_equals_null: &bool
) -> Result<Self>

Tries to create a new HashJoinExec.

Error

This function errors when it is not possible to join the left and right sides on keys on.

pub fn left(&self) -> &Arc<dyn ExecutionPlan>

left (build) side which gets hashed

pub fn right(&self) -> &Arc<dyn ExecutionPlan>

right (probe) side which are filtered by the hash table

pub fn on(&self) -> &[(Column, Column)]

Set of common columns used to join on

pub fn filter(&self) -> &Option<JoinFilter>

Filters applied before join output

pub fn join_type(&self) -> &JoinType

How the join is performed

pub fn partition_mode(&self) -> &PartitionMode

The partitioning mode of this hash join

pub fn null_equals_null(&self) -> &bool

Get null_equals_null

Trait Implementations

impl Debug for HashJoinExec

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

Formats the value using the given formatter.

impl ExecutionPlan for HashJoinExec

fn as_any(&self) -> &dyn Any

Returns the execution plan as Any so that it can be downcast to a specific implementation.

fn schema(&self) -> SchemaRef

Get the schema for this execution plan

fn children(&self) -> Vec<Arc<dyn ExecutionPlan>>

Get a list of child execution plans that provide the input for this plan. The returned list will be empty for leaf nodes, will contain a single value for unary nodes, or two values for binary nodes (such as joins).

fn with_new_children(
    self: Arc<Self>,
    children: Vec<Arc<dyn ExecutionPlan>>
) -> Result<Arc<dyn ExecutionPlan>>

Returns a new plan where all children were replaced by new plans.

fn output_partitioning(&self) -> Partitioning

Specifies the output partitioning scheme of this plan

fn output_ordering(&self) -> Option<&[PhysicalSortExpr]>

If the output of this operator is sorted, returns Some(keys) with the description of how it was sorted.

fn relies_on_input_order(&self) -> bool

Returns true if this operator relies on its inputs being produced in a certain order (for example that they are sorted a particular way) for correctness.

fn execute(
    &self,
    partition: usize,
    context: Arc<TaskContext>
) -> Result<SendableRecordBatchStream>

creates an iterator

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

Format this ExecutionPlan to f in the specified type.

fn metrics(&self) -> Option<MetricsSet>

Return a snapshot of the set of Metrics for this ExecutionPlan.

fn statistics(&self) -> Statistics

Returns the global output statistics for this ExecutionPlan node.

fn required_child_distribution(&self) -> Distribution

Specifies the data distribution requirements of all the children for this operator

fn maintains_input_order(&self) -> bool

Returns false if this operator’s implementation may reorder rows within or between partitions.

fn benefits_from_input_partitioning(&self) -> bool

Returns true if this operator would benefit from partitioning its input (and thus from more parallelism). For operators that do very little work the overhead of extra parallelism may outweigh any benefits