From 25a6791038e220245723d5bf44b455d29d594da5 Mon Sep 17 00:00:00 2001 From: Rohan Krishnaswamy Date: Fri, 31 Jan 2025 12:05:33 -0800 Subject: [PATCH] docs: Clarify join behavior in DataFrame::join docs --- datafusion/core/src/dataframe/mod.rs | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/datafusion/core/src/dataframe/mod.rs b/datafusion/core/src/dataframe/mod.rs index 4d7de5629580..9731b8784076 100644 --- a/datafusion/core/src/dataframe/mod.rs +++ b/datafusion/core/src/dataframe/mod.rs @@ -1004,7 +1004,9 @@ impl DataFrame { /// /// `left_cols` and `right_cols` are used to form "equijoin" predicates (see /// example below), which are then combined with the optional `filter` - /// expression. + /// expression. If `left_cols` and `right_cols` contain ambiguous column + /// references, they will be disambiguated by prioritizing the left relation + /// for `left_cols` and the right relation for `right_cols`. /// /// Note that in case of outer join, the `filter` is applied to only matched rows. ///