pyspark.sql.functions.year#

pyspark.sql.functions.year(col)[source]#

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 column name: target date/timestamp column to work on.

Returns

Column: year part of the date/timestamp as integer.

Examples

Example 1: Extract the year from a string column representing dates

>>> from pyspark.sql import functions as sf
>>> df = spark.createDataFrame([('2015-04-08',), ('2024-10-31',)], ['dt'])
>>> df.select("*", sf.typeof('dt'), sf.year('dt')).show()
+----------+----------+--------+
|        dt|typeof(dt)|year(dt)|
+----------+----------+--------+
|2015-04-08|    string|    2015|
|2024-10-31|    string|    2024|
+----------+----------+--------+

Example 2: Extract the year from a string column representing timestamp

>>> from pyspark.sql import functions as sf
>>> df = spark.createDataFrame([('2015-04-08 13:08:15',), ('2024-10-31 10:09:16',)], ['ts'])
>>> df.select("*", sf.typeof('ts'), sf.year('ts')).show()
+-------------------+----------+--------+
|                 ts|typeof(ts)|year(ts)|
+-------------------+----------+--------+
|2015-04-08 13:08:15|    string|    2015|
|2024-10-31 10:09:16|    string|    2024|
+-------------------+----------+--------+

Example 3: Extract the year from a date column

>>> import datetime
>>> from pyspark.sql import functions as sf
>>> df = spark.createDataFrame([
...     (datetime.date(2015, 4, 8),),
...     (datetime.date(2024, 10, 31),)], ['dt'])
>>> df.select("*", sf.typeof('dt'), sf.year('dt')).show()
+----------+----------+--------+
|        dt|typeof(dt)|year(dt)|
+----------+----------+--------+
|2015-04-08|      date|    2015|
|2024-10-31|      date|    2024|
+----------+----------+--------+

Example 4: Extract the year from a timestamp column

>>> import datetime
>>> from pyspark.sql import functions as sf
>>> df = spark.createDataFrame([
...     (datetime.datetime(2015, 4, 8, 13, 8, 15),),
...     (datetime.datetime(2024, 10, 31, 10, 9, 16),)], ['ts'])
>>> df.select("*", sf.typeof('ts'), sf.year('ts')).show()
+-------------------+----------+--------+
|                 ts|typeof(ts)|year(ts)|
+-------------------+----------+--------+
|2015-04-08 13:08:15| timestamp|    2015|
|2024-10-31 10:09:16| timestamp|    2024|
+-------------------+----------+--------+