pyspark.sql.functions.year

pyspark.sql.functions.year(col: ColumnOrName) → pyspark.sql.column.Column

Extract the year of a given date/timestamp as integer.

New in version 1.5.0.

Changed in version 3.4.0: Supports Spark Connect.

Parameters

colColumn or str

target date/timestamp column to work on.

Returns

Column

year part of the date/timestamp as integer.

Examples

>>> df = spark.createDataFrame([('2015-04-08',)], ['dt'])
>>> df.select(year('dt').alias('year')).collect()
[Row(year=2015)]

previous

pyspark.sql.functions.weekofyear

next

pyspark.sql.functions.quarter