org.apache.spark.sql.expressions

Class WindowSpec

java.lang.Object

org.apache.spark.sql.expressions.WindowSpec

public class WindowSpec
extends java.lang.Object

:: Experimental :: A window specification that defines the partitioning, ordering, and frame boundaries.

Use the static methods in Window to create a WindowSpec.

Since:

1.4.0

Method Summary

Methods

Modifier and Type	Method and Description
WindowSpec	orderBy(Column... cols) Defines the ordering columns in a WindowSpec.
WindowSpec	orderBy(scala.collection.Seq<Column> cols) Defines the ordering columns in a WindowSpec.
WindowSpec	orderBy(java.lang.String colName, scala.collection.Seq<java.lang.String> colNames) Defines the ordering columns in a WindowSpec.
WindowSpec	orderBy(java.lang.String colName, java.lang.String... colNames) Defines the ordering columns in a WindowSpec.
WindowSpec	partitionBy(Column... cols) Defines the partitioning columns in a WindowSpec.
WindowSpec	partitionBy(scala.collection.Seq<Column> cols) Defines the partitioning columns in a WindowSpec.
WindowSpec	partitionBy(java.lang.String colName, scala.collection.Seq<java.lang.String> colNames) Defines the partitioning columns in a WindowSpec.
WindowSpec	partitionBy(java.lang.String colName, java.lang.String... colNames) Defines the partitioning columns in a WindowSpec.
WindowSpec	rangeBetween(long start, long end) Defines the frame boundaries, from start (inclusive) to end (inclusive).
WindowSpec	rowsBetween(long start, long end) Defines the frame boundaries, from start (inclusive) to end (inclusive).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

partitionBy

public WindowSpec partitionBy(java.lang.String colName,
                     java.lang.String... colNames)

Defines the partitioning columns in a WindowSpec.

Parameters:

colName - (undocumented)

colNames - (undocumented)

Returns:

(undocumented)

Since:

1.4.0

partitionBy

public WindowSpec partitionBy(Column... cols)

Defines the partitioning columns in a WindowSpec.

Parameters:

cols - (undocumented)

Returns:

(undocumented)

Since:

1.4.0

orderBy

public WindowSpec orderBy(java.lang.String colName,
                 java.lang.String... colNames)

Defines the ordering columns in a WindowSpec.

Parameters:

colName - (undocumented)

colNames - (undocumented)

Returns:

(undocumented)

Since:

1.4.0

orderBy

public WindowSpec orderBy(Column... cols)

Defines the ordering columns in a WindowSpec.

Parameters:

cols - (undocumented)

Returns:

(undocumented)

Since:

1.4.0

partitionBy

public WindowSpec partitionBy(java.lang.String colName,
                     scala.collection.Seq<java.lang.String> colNames)

Defines the partitioning columns in a WindowSpec.

Parameters:

colName - (undocumented)

colNames - (undocumented)

Returns:

(undocumented)

Since:

1.4.0

partitionBy

public WindowSpec partitionBy(scala.collection.Seq<Column> cols)

Defines the partitioning columns in a WindowSpec.

Parameters:

cols - (undocumented)

Returns:

(undocumented)

Since:

1.4.0

orderBy

public WindowSpec orderBy(java.lang.String colName,
                 scala.collection.Seq<java.lang.String> colNames)

Defines the ordering columns in a WindowSpec.

Parameters:

colName - (undocumented)

colNames - (undocumented)

Returns:

(undocumented)

Since:

1.4.0

orderBy

public WindowSpec orderBy(scala.collection.Seq<Column> cols)

Defines the ordering columns in a WindowSpec.

Parameters:

cols - (undocumented)

Returns:

(undocumented)

Since:

1.4.0

rowsBetween

public WindowSpec rowsBetween(long start,
                     long end)

Defines the frame boundaries, from start (inclusive) to end (inclusive).

Both start and end are relative positions from 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.

Parameters:

start - boundary start, inclusive. The frame is unbounded if this is the minimum long value.

end - boundary end, inclusive. The frame is unbounded if this is the maximum long value.

Returns:

(undocumented)

Since:

1.4.0

rangeBetween

public WindowSpec rangeBetween(long start,
                      long end)

Defines the frame boundaries, from start (inclusive) to end (inclusive).

Both start and end are relative from 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.

Parameters:

start - boundary start, inclusive. The frame is unbounded if this is the minimum long value.

end - boundary end, inclusive. The frame is unbounded if this is the maximum long value.

Returns:

(undocumented)

Since:

1.4.0