doc/user/content/transform-data/idiomatic-materialize-sql/lead.md
The "lead over" query pattern accesses the field value of the next row as determined by some ordering.
For "lead over (order by)" queries whose ordering can be represented by some equality condition (such as when ordering by a field that increases at a regular interval), Materialize provides an idiomatic SQL as an alternative to the window function.
{{< callout >}}
{{< idiomatic-sql/materialize-window-functions >}}
{{</ callout >}}
{{< important >}}
Do not use if the "lead over (order by)" ordering cannot be represented by an equality match.
{{</ important >}}
Idiomatic Materialize SQL: To access the lead (next row's field value)
ordered by some field that increases in regular intervals, use a self join
that specifies an equality condition on the order by field (e.g., WHERE t1.order_field = t2.order_field - 1, WHERE t1.order_field = t2.order_field * 2, etc.). The query excludes the last row in the results since it does not
have a next row.
Use a self join that specifies an equality match on the lead's order by
field (e.g., fieldA). The order by field must increment in a regular pattern
in order to be represented by an equality condition (e.g., WHERE t1.fieldA = t2.fieldA - ...). The query excludes the last row in the results since it
does not have a next row.
{{< important >}}
The idiomatic Materialize SQL applies only to those "lead over" queries whose ordering can be represented by some equality condition.
{{</ important >}}
-- Excludes the last row in the results --
SELECT t1.fieldA, t2.fieldB as next_row_value
FROM tableA t1, tableA t2
WHERE t1.fieldA = t2.fieldA - ... -- or some other operand
ORDER BY fieldA;
Avoid the use of LEAD(fieldZ) OVER (ORDER BY ...) window function when the order by field increases in a regular pattern.
-- Anti-pattern. Avoid. --
SELECT fieldA, ...
LEAD(fieldZ) OVER (ORDER BY fieldA) as next_row_value
FROM tableA;
Idiomatic Materialize SQL: To access the lead (next row's field value)
ordered by some field that increases in regular intervals, use a self LEFT JOIN/LEFT OUTER JOIN that specifies an
equality condition on the order by field (e.g., ON t1.order_field = t2.order_field - 1, ON t1.order_field = t2.order_field * 2, etc.). The LEFT JOIN/LEFT OUTER JOIN query includes the last row, returning null as its
lead value.
Use a self LEFT JOIN/LEFT OUTER JOIN
(e.g., FROM tableA t1 LEFT JOIN tableA t2) that specifies an equality
match on the lag's order by field (e.g., fieldA). The order by field must
increment in a regular pattern in order to be represented by an equality
condition (e.g., ON t1.fieldA = t2.fieldA - ...). The query includes the
last row, returning null as its lead value.
{{< important >}}
The idiomatic Materialize SQL applies only to those "lead over" queries whose ordering can be represented by some equality condition.
{{</ important >}}
-- Includes the last row in the response --
SELECT t1.fieldA, t2.fieldB as next_row_value
FROM tableA t1
LEFT JOIN tableA t2
ON t1.fieldA = t2.fieldA - ... -- or some other operand
ORDER BY fieldA;
Avoid the use of LEAD(fieldZ) OVER (ORDER BY ...) window function when the order by field increases in regular
intervals.
SELECT fieldA, ...
LEAD(fieldZ) OVER (ORDER BY fieldA) as next_row_value
FROM tableA;
{{< note >}}
The example data can be found in the Appendix.
{{</ note >}}
Using idiomatic Materialize SQL, the following example finds the next day's
order total. That is, the example uses a self join on orders_daily_totals. The
row ordering on the order_date field is represented by an equality
condition using an interval of 1 DAY. The
query excludes the last row in the results since the last row does not have a
next row.
-- Excludes the last row in results --
SELECT o1.order_date, o1.daily_total,
o2.daily_total as next_daily_total
FROM orders_daily_totals o1, orders_daily_totals o2
WHERE o1.order_date = o2.order_date - INTERVAL '1' DAY
ORDER BY order_date;
{{< important >}}
The idiomatic Materialize SQL applies only to those "lead over" queries whose ordering can be represented by some equality condition.
{{</ important >}}
</td> </tr> <tr> <td><red>Anti-pattern</red> ❌</td> <td><red>Avoid the use of LEAD() OVER (ORDER BY ...)
window function to access next row's value if the
order by field increases in regular intervals.</red>
-- Anti-pattern. Includes the last row's value. --
SELECT order_date, daily_total,
LEAD(daily_total) OVER (ORDER BY order_date) as next_daily_total
FROM orders_daily_totals;
Using idiomatic Materialize SQL, the following example finds the next day's
order total. The example uses a self LEFT JOIN/LEFT OUTER JOIN on orders_daily_totals. The row
ordering on the order_date field is represented by an equality condition
using an interval of 1 DAY). The
query includes the last row in the results, using null as the next row's
value.
-- Include the last row in the results --
SELECT o1.order_date, o1.daily_total,
o2.daily_total as next_daily_total
FROM orders_daily_totals o1
LEFT JOIN orders_daily_totals o2
ON o1.order_date = o2.order_date - INTERVAL '1' DAY
ORDER BY order_date;
{{< important >}}
The idiomatic Materialize SQL applies only to those "lead over" queries whose ordering can be represented by some equality condition.
{{</ important >}}
</td> </tr> <tr> <td><red>Anti-pattern</red> ❌</td> <td><red>Avoid the use of LEAD() OVER (ORDER BY ...)
window function to access next row's value if the
order by field increases in a regular pattern.</red>
-- Anti-pattern. Includes the last row in results. --
SELECT order_date, daily_total,
LEAD(daily_total) OVER (ORDER BY order_date) as next_daily_total
FROM orders_daily_totals;