View Source

Computes the rolling sum of values forward or backward of the current row within the specified column.

If an input value is missing or null, it is not factored in the computation. For example, for the first row in the dataset, the rolling sum of previous values is the value in the first row.
The row from which to extract a value is determined by the order in which the rows are organized based on the order parameter.
If you are working on a randomly generated sample of your dataset, the values that you see for this function might not correspond to the values that are generated on the full dataset during job execution.
The function takes a column name and two optional integer parameters that determine the window backward and forward of the current row.
- The default integer parameter values are -1 and 0, which computes the rolling average from the current row back to the first row of the dataset.
This function works with the Window transform. See Window Transform.

Column example:

rollingsum(myCol)

Output: Returns the rolling sum of all values in the myCol column.

Rows before example:

rollingsum(myNumber, 3)

Output: Returns the rolling sum of the current row and the three previous row values in the myNumber column.

Rows before and after example:

rollingsum(myNumber, 3, 2)

Output: Returns the rolling sum of the three previous row values, the current row value, and the two rows after the current one in the myNumber column.

rollingsum(col_ref, rowsBefore_integer, rowsAfter_integer) order: order_col [group: group_col]

Argument	Required?	Data Type	Description
col_ref	Y	string	Name of column whose values are applied to the function
rowsBefore_integer	N	integer	Number of rows before the current one to include in the computation.
rowsAfter_integer	N	integer	Number of rows after the current one to include in the computation

For more information on the order and group parameters, see Window Transform.

col_ref

Name of the column whose values are used to compute the rolling sum.

Multiple columns and wildcards are not supported.

Required?	Data Type	Example Value
Yes	String (column reference to Integer or Decimal values)	`myColumn`

rowsBefore_integer, rowsAfter_integer

Integers representing the number of rows before or after the current one from which to compute the rolling sum, including the current row. For example, if the first value is 5, the current row and the five rows before it are used in the computation. Negative values for rowsAfter_integer compute the rolling function from rows preceding the current one.

rowBefore=0 generates the current row value only.
rowBefore=-1 uses all rows preceding the current one.
If rowsAfter is not specified, then the value 0 is applied.
If a group parameter is applied, then these parameter values should be no more than the maximum number of rows in the groups.

Required?	Data Type	Example Value
No	Integer	`4`

col_ref

rowsBefore_integer, rowsAfter_integer

Example - Rolling window functions