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/datafusion.git
The following commit(s) were added to refs/heads/main by this push:
new 3930830706 Minor: improve `LogicalPlanBuilder::join_with_expr_keys`
docs (#13276)
3930830706 is described below
commit 39308307061505ef8b4debb203d60855247db217
Author: Andrew Lamb <[email protected]>
AuthorDate: Thu Nov 7 12:53:53 2024 -0500
Minor: improve `LogicalPlanBuilder::join_with_expr_keys` docs (#13276)
* Minor: improve LogicalPlanBuilder::join_with_expr_keys docs
* Update datafusion/expr/src/logical_plan/builder.rs
Co-authored-by: Jonathan Chen <[email protected]>
---------
Co-authored-by: Jonathan Chen <[email protected]>
---
datafusion/expr/src/logical_plan/builder.rs | 18 +++++++++++++-----
1 file changed, 13 insertions(+), 5 deletions(-)
diff --git a/datafusion/expr/src/logical_plan/builder.rs
b/datafusion/expr/src/logical_plan/builder.rs
index 790fc508d4..beb729fc7c 100644
--- a/datafusion/expr/src/logical_plan/builder.rs
+++ b/datafusion/expr/src/logical_plan/builder.rs
@@ -777,7 +777,7 @@ impl LogicalPlanBuilder {
self.join_detailed(right, join_type, join_keys, filter, false)
}
- /// Apply a join with using the specified expressions.
+ /// Apply a join using the specified expressions.
///
/// Note that DataFusion automatically optimizes joins, including
/// identifying and optimizing equality predicates.
@@ -1200,12 +1200,20 @@ impl LogicalPlanBuilder {
Ok(Arc::unwrap_or_clone(self.plan))
}
- /// Apply a join with the expression on constraint.
+ /// Apply a join with both explicit equijoin and non equijoin predicates.
///
- /// equi_exprs are "equijoin" predicates expressions on the existing and
right inputs, respectively.
+ /// Note this is a low level API that requires identifying specific
+ /// predicate types. Most users should use [`join_on`](Self::join_on) that
+ /// automatically identifies predicates appropriately.
///
- /// filter: any other filter expression to apply during the join.
equi_exprs predicates are likely
- /// to be evaluated more quickly than the filter expressions
+ /// `equi_exprs` defines equijoin predicates, of the form `l = r)` for each
+ /// `(l, r)` tuple. `l`, the first element of the tuple, must only refer
+ /// to columns from the existing input. `r`, the second element of the
tuple,
+ /// must only refer to columns from the right input.
+ ///
+ /// `filter` contains any other other filter expression to apply during the
+ /// join. Note that `equi_exprs` predicates are evaluated more efficiently
+ /// than the filter expressions, so they are preferred.
pub fn join_with_expr_keys(
self,
right: LogicalPlan,
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
