This is an automated email from the ASF dual-hosted git repository.
alamb pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/arrow-datafusion.git
The following commit(s) were added to refs/heads/main by this push:
new 21b96261b4 Improve documentation for calculate_prune_length method in
`SymmetricHashJoin` (#8125)
21b96261b4 is described below
commit 21b96261b48b86381edbdda8c7405f764d9aea33
Author: Asura7969 <[email protected]>
AuthorDate: Sat Nov 11 19:10:28 2023 +0800
Improve documentation for calculate_prune_length method in
`SymmetricHashJoin` (#8125)
* Minor: Improve the document format of JoinHashMap
* Minor: Improve documentation for calculate_prune_length method
* fix: method describe
---
.../physical-plan/src/joins/symmetric_hash_join.rs | 16 +++-------------
1 file changed, 3 insertions(+), 13 deletions(-)
diff --git a/datafusion/physical-plan/src/joins/symmetric_hash_join.rs
b/datafusion/physical-plan/src/joins/symmetric_hash_join.rs
index 39ac25ecb5..1306a48744 100644
--- a/datafusion/physical-plan/src/joins/symmetric_hash_join.rs
+++ b/datafusion/physical-plan/src/joins/symmetric_hash_join.rs
@@ -952,27 +952,17 @@ impl OneSideHashJoiner {
Ok(())
}
- /// Prunes the internal buffer.
- ///
- /// Argument `probe_batch` is used to update the intervals of the sorted
- /// filter expressions. The updated build interval determines the new
length
- /// of the build side. If there are rows to prune, they are removed from
the
- /// internal buffer.
+ /// Calculate prune length.
///
/// # Arguments
///
- /// * `schema` - The schema of the final output record batch
- /// * `probe_batch` - Incoming RecordBatch of the probe side.
+ /// * `build_side_sorted_filter_expr` - Build side mutable sorted filter
expression..
/// * `probe_side_sorted_filter_expr` - Probe side mutable sorted filter
expression.
- /// * `join_type` - The type of join (e.g. inner, left, right, etc.).
- /// * `column_indices` - A vector of column indices that specifies which
columns from the
- /// build side should be included in the output.
/// * `graph` - A mutable reference to the physical expression graph.
///
/// # Returns
///
- /// If there are rows to prune, returns the pruned build side record batch
wrapped in an `Ok` variant.
- /// Otherwise, returns `Ok(None)`.
+ /// A Result object that contains the pruning length.
pub(crate) fn calculate_prune_length_with_probe_batch(
&mut self,
build_side_sorted_filter_expr: &mut SortedFilterExpr,
