jonathanc-n commented on code in PR #13276:
URL: https://github.com/apache/datafusion/pull/13276#discussion_r1831067493
##########
datafusion/expr/src/logical_plan/builder.rs:
##########
@@ -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 are preferred.
Review Comment:
```suggestion
/// than the filter expressions, so they are preferred.
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
