pyspark.sql.functions.partitioning.years

pyspark.sql.functions.partitioning.years(col)

Partition transform function: A transform for timestamps and dates to partition data into years.

Added in version 4.0.0.

Parameters:

colColumn or str

target date or timestamp column to work on.

Returns:

Column

data partitioned by years.

Notes

This function can be used only in combination with partitionedBy() method of the DataFrameWriterV2.

Examples

>>> df.writeTo("catalog.db.table").partitionedBy(
...     partitioning.years("ts")
... ).createOrReplace()