join_with_probe_batch

datafusion_physical_plan::joins::symmetric_hash_join

Function join_with_probe_batch 

Source 
pub(crate) fn join_with_probe_batch(
    build_hash_joiner: &mut OneSideHashJoiner,
    probe_hash_joiner: &mut OneSideHashJoiner,
    schema: &SchemaRef,
    join_type: JoinType,
    filter: Option<&JoinFilter>,
    probe_batch: &RecordBatch,
    column_indices: &[ColumnIndex],
    random_state: &RandomState,
    null_equality: NullEquality,
) -> Result<Option<RecordBatch>>
Expand description

This method performs a join between the build side input buffer and the probe side batch.

§Arguments

  • build_hash_joiner - Build side hash joiner
  • probe_hash_joiner - Probe side hash joiner
  • schema - A reference to the schema of the output record batch.
  • join_type - The type of join to be performed.
  • on_probe - An array of columns on which the join will be performed. The columns are from the probe side of the join.
  • filter - An optional filter on the join condition.
  • probe_batch - The second record batch to be joined.
  • column_indices - An array of columns to be selected for the result of the join.
  • random_state - The random state for the join.
  • null_equality - Indicates whether NULL values should be treated as equal when joining.

§Returns

A Result containing an optional record batch if the join type is not one of LeftAnti, RightAnti, LeftSemi or RightSemi. If the join type is one of the above four, the function will return None.