pyspark.sql.functions.trunc

pyspark.sql.functions.trunc(date: ColumnOrName, format: str) → pyspark.sql.column.Column

Returns date truncated to the unit specified by the format.

Parameters

dateColumn or str

formatstr

‘year’, ‘yyyy’, ‘yy’ to truncate by year, or ‘month’, ‘mon’, ‘mm’ to truncate by month Other options are: ‘week’, ‘quarter’

Examples

>>> df = spark.createDataFrame([('1997-02-28',)], ['d'])
>>> df.select(trunc(df.d, 'year').alias('year')).collect()
[Row(year=datetime.date(1997, 1, 1))]
>>> df.select(trunc(df.d, 'mon').alias('month')).collect()
[Row(month=datetime.date(1997, 2, 1))]

previous

pyspark.sql.functions.to_date

next

pyspark.sql.functions.from_utc_timestamp