aboutsummaryrefslogtreecommitdiff
path: root/python/pyspark/sql
diff options
context:
space:
mode:
authoranabranch <wac.chambers@gmail.com>2017-01-08 20:37:46 -0800
committerFelix Cheung <felixcheung@apache.org>2017-01-08 20:37:46 -0800
commit19d9d4c855eab8f647a5ec66b079172de81221d0 (patch)
tree3bad937b8bc7929af833c749c68aab8b32c51379 /python/pyspark/sql
parent1f6ded6455d07ec8828fc9662ddffe55cbba4238 (diff)
downloadspark-19d9d4c855eab8f647a5ec66b079172de81221d0.tar.gz
spark-19d9d4c855eab8f647a5ec66b079172de81221d0.tar.bz2
spark-19d9d4c855eab8f647a5ec66b079172de81221d0.zip
[SPARK-19126][DOCS] Update Join Documentation Across Languages
## What changes were proposed in this pull request? - [X] Make sure all join types are clearly mentioned - [X] Make join labeling/style consistent - [X] Make join label ordering docs the same - [X] Improve join documentation according to above for Scala - [X] Improve join documentation according to above for Python - [X] Improve join documentation according to above for R ## How was this patch tested? No tests b/c docs. Please review http://spark.apache.org/contributing.html before opening a pull request. Author: anabranch <wac.chambers@gmail.com> Closes #16504 from anabranch/SPARK-19126.
Diffstat (limited to 'python/pyspark/sql')
-rw-r--r--python/pyspark/sql/dataframe.py5
1 files changed, 3 insertions, 2 deletions
diff --git a/python/pyspark/sql/dataframe.py b/python/pyspark/sql/dataframe.py
index b9d90384e3..10e42d0f9d 100644
--- a/python/pyspark/sql/dataframe.py
+++ b/python/pyspark/sql/dataframe.py
@@ -730,8 +730,9 @@ class DataFrame(object):
a join expression (Column), or a list of Columns.
If `on` is a string or a list of strings indicating the name of the join column(s),
the column(s) must exist on both sides, and this performs an equi-join.
- :param how: str, default 'inner'.
- One of `inner`, `outer`, `left_outer`, `right_outer`, `leftsemi`.
+ :param how: str, default ``inner``. Must be one of: ``inner``, ``cross``, ``outer``,
+ ``full``, ``full_outer``, ``left``, ``left_outer``, ``right``, ``right_outer``,
+ ``left_semi``, and ``left_anti``.
The following performs a full outer join between ``df1`` and ``df2``.