Window

const Window: {
  currentRow: number;
  unboundedFollowing: number;
  unboundedPreceding: number;
  orderBy: WindowSpec;
  partitionBy: WindowSpec;
  rangeBetween: WindowSpec;
  rowsBetween: WindowSpec;
};

Defined in: window.ts:117

Entry point for building a WindowSpec.

Mirrors PySpark’s Window object. Expose partitionBy, orderBy, rowsBetween, and rangeBetween as factories, plus the boundary constants unboundedPreceding, unboundedFollowing, and currentRow.

Type Declaration

currentRow

currentRow: number = 0;

unboundedFollowing

unboundedFollowing: number = 2147483647;

unboundedPreceding

unboundedPreceding: number = -2147483648;

orderBy()

orderBy(...cols): WindowSpec;

Create a window spec ordered by the given columns.

Parameters

Parameter	Type
…cols	ColOrName[]

Returns

WindowSpec

partitionBy()

partitionBy(...cols): WindowSpec;

Create a window spec partitioned by the given columns.

Parameters

Parameter	Type
…cols	ColOrName[]

Returns

WindowSpec

rangeBetween()

rangeBetween(start, end): WindowSpec;

Create an unpartitioned, unordered window with range-based frame.

Parameters

Parameter	Type
start	number
end	number

Returns

WindowSpec

rowsBetween()

rowsBetween(start, end): WindowSpec;

Create an unpartitioned, unordered window with row-based frame.

Parameters

Parameter	Type
start	number
end	number

Returns

WindowSpec

Example

import { Window, col } from "@spark-connect-js/core";

const spec = Window
  .partitionBy("country")
  .orderBy(col("ts"))
  .rowsBetween(Window.unboundedPreceding, Window.currentRow);