Skip to content

[SPARK-23861][SQL][Doc] Clarify default window frame with and without orderBy clause #20978

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
icexelloss wants to merge 3 commits into from
Closed

[SPARK-23861][SQL][Doc] Clarify default window frame with and without orderBy clause #20978

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0b6f5fc
Add note for default frame boundaries
icexelloss Apr 4, 2018
f96eaea
Reword
icexelloss Apr 4, 2018
8fb7527
Reword
icexelloss Apr 5, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Reword
  • Loading branch information
@icexelloss
icexelloss committed Apr 4, 2018
commit f96eaeaaa420cebfe8d3b7232edc62f4f3c12a74
6 changes: 3 additions & 3 deletions python/pyspark/sql/window.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,9 +44,9 @@ class Window(object):
>>> # PARTITION BY country ORDER BY date RANGE BETWEEN 3 PRECEDING AND 3 FOLLOWING
>>> window = Window.orderBy("date").partitionBy("country").rangeBetween(-3, 3)

.. note:: The default frame boundaries for window are (rowFrame, unboundedPreceding,
unboundedFollowing). When a ordering is defined, the default frame boundaries
for window are (rangeFrame, unboundedPreceding, currentRow).
.. note:: When ordering is not defined, the default frame boundaries are (rowFrame,
unboundedPreceding, unboundedFollowing). When ordering is defined, the default frame
boundaries are (rangeFrame, unboundedPreceding, currentRow).

.. note:: Experimental

Expand Down
6 changes: 3 additions & 3 deletions sql/core/src/main/scala/org/apache/spark/sql/expressions/Window.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,9 +33,9 @@ import org.apache.spark.sql.catalyst.expressions._
* Window.partitionBy("country").orderBy("date").rowsBetween(-3, 3)
* }}}
*
* @note The default frame boundaries for window are (rowFrame, unboundedPreceding,
* unboundedFollowing). When a ordering is defined, the default frame boundaries
* for window are (rangeFrame, unboundedPreceding, currentRow).
* @note When ordering is not defined, the default frame boundaries are (rowFrame,
Copy link
Contributor

@hvanhovell hvanhovell Apr 5, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I tried to improve the wording (feel free not to use this):

When ordering is not defined, an unbounded window frame (rowFrame, unboundedPreceding, unboundedFollowing) is used by default. When ordering is defined, a growing window frame (rangeFrame, unboundedPreceding, currentRow) is used by default.

Copy link
Contributor Author

@icexelloss icexelloss Apr 6, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think your wording is better. Updated.

* unboundedPreceding, unboundedFollowing). When ordering is defined, the default frame
* boundaries are (rangeFrame, unboundedPreceding, currentRow).
*
* @since 1.4.0
*/
Expand Down