Struct datafusion::physical_plan::hash_join::HashJoinExec

pub struct HashJoinExec { /* fields omitted */ }

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

Implementations

impl HashJoinExec

pub fn try_new(
    left: Arc<dyn ExecutionPlan>,
    right: Arc<dyn ExecutionPlan>,
    on: JoinOn,
    join_type: &JoinType,
    partition_mode: PartitionMode
) -> 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 join_type(&self) -> &JoinType

How the join is performed

pub fn partition_mode(&self) -> &PartitionMode

The partitioning mode of this hash join

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,
    children: Vec<Arc<dyn ExecutionPlan>>
) -> Result<Arc<dyn ExecutionPlan>>

Returns a new plan where all children were replaced by new plans. The size of children must be equal to the size of ExecutionPlan::children().

fn output_partitioning(&self) -> Partitioning

Specifies the output partitioning scheme of this plan

fn execute<'life0, 'async_trait>(
    &'life0 self,
    partition: usize
) -> Pin<Box<dyn Future<Output = Result<SendableRecordBatchStream>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

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) -> HashMap<String, SQLMetric>

Return a snapshot of the metrics collected during execution

fn required_child_distribution(&self) -> Distribution

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