Packages

object Window

Utility functions for defining window in DataFrames.

// PARTITION BY country ORDER BY date ROWS BETWEEN UNBOUNDED PRECEDING AND CURRENT ROW
Window.partitionBy("country").orderBy("date")
  .rowsBetween(Window.unboundedPreceding, Window.currentRow)

// PARTITION BY country ORDER BY date ROWS BETWEEN 3 PRECEDING AND 3 FOLLOWING
Window.partitionBy("country").orderBy("date").rowsBetween(-3, 3)
Annotations
@Stable()
Since

1.4.0

Note

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.

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Window
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  6. def currentRow: Long

    Value representing the current row.

    Value representing the current row. This can be used to specify the frame boundaries:

    Window.rowsBetween(Window.unboundedPreceding, Window.currentRow)
    Since

    2.1.0

  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  9. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  10. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  12. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  13. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  15. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  16. def orderBy(cols: Column*): WindowSpec

    Creates a WindowSpec with the ordering defined.

    Creates a WindowSpec with the ordering defined.

    Annotations
    @varargs()
    Since

    1.4.0

  17. def orderBy(colName: String, colNames: String*): WindowSpec

    Creates a WindowSpec with the ordering defined.

    Creates a WindowSpec with the ordering defined.

    Annotations
    @varargs()
    Since

    1.4.0

  18. def partitionBy(cols: Column*): WindowSpec

    Creates a WindowSpec with the partitioning defined.

    Creates a WindowSpec with the partitioning defined.

    Annotations
    @varargs()
    Since

    1.4.0

  19. def partitionBy(colName: String, colNames: String*): WindowSpec

    Creates a WindowSpec with the partitioning defined.

    Creates a WindowSpec with the partitioning defined.

    Annotations
    @varargs()
    Since

    1.4.0

  20. def rangeBetween(start: Long, end: Long): WindowSpec

    Creates a WindowSpec with the frame boundaries defined, from start (inclusive) to end (inclusive).

    Creates a WindowSpec with the frame boundaries defined, from start (inclusive) to end (inclusive).

    Both start and end are relative to the current row. For example, "0" means "current row", while "-1" means one off before the current row, and "5" means the five off after the current row.

    We recommend users use Window.unboundedPreceding, Window.unboundedFollowing, and Window.currentRow to specify special boundary values, rather than using long values directly.

    A range-based boundary is based on the actual value of the ORDER BY expression(s). An offset is used to alter the value of the ORDER BY expression, for instance if the current order by expression has a value of 10 and the lower bound offset is -3, the resulting lower bound for the current row will be 10 - 3 = 7. This however puts a number of constraints on the ORDER BY expressions: there can be only one expression and this expression must have a numerical data type. An exception can be made when the offset is unbounded, because no value modification is needed, in this case multiple and non-numeric ORDER BY expression are allowed.

    import org.apache.spark.sql.expressions.Window
val df = Seq((1, "a"), (1, "a"), (2, "a"), (1, "b"), (2, "b"), (3, "b"))
  .toDF("id", "category")
val byCategoryOrderedById =
  Window.partitionBy('category).orderBy('id).rangeBetween(Window.currentRow, 1)
df.withColumn("sum", sum('id) over byCategoryOrderedById).show()

+---+--------+---+
| id|category|sum|
+---+--------+---+
|  1|       b|  3|
|  2|       b|  5|
|  3|       b|  3|
|  1|       a|  4|
|  1|       a|  4|
|  2|       a|  2|
+---+--------+---+
    start

    boundary start, inclusive. The frame is unbounded if this is the minimum long value (Window.unboundedPreceding).

    end

    boundary end, inclusive. The frame is unbounded if this is the maximum long value (Window.unboundedFollowing).

    Since

    2.1.0

  21. def rowsBetween(start: Long, end: Long): WindowSpec

    Creates a WindowSpec with the frame boundaries defined, from start (inclusive) to end (inclusive).

    Creates a WindowSpec with the frame boundaries defined, from start (inclusive) to end (inclusive).

    Both start and end are positions relative to the current row. For example, "0" means "current row", while "-1" means the row before the current row, and "5" means the fifth row after the current row.

    We recommend users use Window.unboundedPreceding, Window.unboundedFollowing, and Window.currentRow to specify special boundary values, rather than using integral values directly.

    A row based boundary is based on the position of the row within the partition. An offset indicates the number of rows above or below the current row, the frame for the current row starts or ends. For instance, given a row based sliding frame with a lower bound offset of -1 and a upper bound offset of +2. The frame for row with index 5 would range from index 4 to index 6.

    import org.apache.spark.sql.expressions.Window
val df = Seq((1, "a"), (1, "a"), (2, "a"), (1, "b"), (2, "b"), (3, "b"))
  .toDF("id", "category")
val byCategoryOrderedById =
  Window.partitionBy('category).orderBy('id).rowsBetween(Window.currentRow, 1)
df.withColumn("sum", sum('id) over byCategoryOrderedById).show()

+---+--------+---+
| id|category|sum|
+---+--------+---+
|  1|       b|  3|
|  2|       b|  5|
|  3|       b|  3|
|  1|       a|  2|
|  1|       a|  3|
|  2|       a|  2|
+---+--------+---+
    start

    boundary start, inclusive. The frame is unbounded if this is the minimum long value (Window.unboundedPreceding).

    end

    boundary end, inclusive. The frame is unbounded if this is the maximum long value (Window.unboundedFollowing).

    Since

    2.1.0

  22. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  23. def toString(): String
    Definition Classes
    AnyRef → Any
  24. def unboundedFollowing: Long

    Value representing the last row in the partition, equivalent to "UNBOUNDED FOLLOWING" in SQL.

    Value representing the last row in the partition, equivalent to "UNBOUNDED FOLLOWING" in SQL. This can be used to specify the frame boundaries:

    Window.rowsBetween(Window.unboundedPreceding, Window.unboundedFollowing)
    Since

    2.1.0

  25. def unboundedPreceding: Long

    Value representing the first row in the partition, equivalent to "UNBOUNDED PRECEDING" in SQL.

    Value representing the first row in the partition, equivalent to "UNBOUNDED PRECEDING" in SQL. This can be used to specify the frame boundaries:

    Window.rowsBetween(Window.unboundedPreceding, Window.currentRow)
    Since

    2.1.0

  26. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  27. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  28. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped