Function lead

  • lead(column: string | Column, offset: number): Column

    Window function: returns the value that is offset rows after the current row.

    Parameters

    • column: string | Column

      The column name or Column to compute lead for

    • offset: number

      The number of rows to look ahead

    Returns Column

    A Column representing the lead value

    Example

    df.select(lead(col("value"), 1))
  • lead(column: string | Column, offset: number, defaultValue: any): Column

    Window function: returns the value that is offset rows after the current row, with default value.

    Parameters

    • column: string | Column

      The column name or Column to compute lead for

    • offset: number

      The number of rows to look ahead

    • defaultValue: any

      Default value when the offset is beyond the window

    Returns Column

    A Column representing the lead value

  • lead(
        column: string | Column,
        offset: number,
        defaultValue: any,
        ignoreNulls: boolean,
    ): Column

    Window function: returns the value that is offset rows after the current row, with default value and null handling.

    Parameters

    • column: string | Column

      The column name or Column to compute lead for

    • offset: number

      The number of rows to look ahead

    • defaultValue: any

      Default value when the offset is beyond the window

    • ignoreNulls: boolean

      Whether to skip null values

    Returns Column

    A Column representing the lead value

Settings

Member Visibility