pyspark.sql.functions.months_between(date1, date2, roundOff=True)[source]

Returns number of months between dates date1 and date2. If date1 is later than date2, then the result is positive. If date1 and date2 are on the same day of month, or both are the last day of month, returns an integer (time of day will be ignored). The result is rounded off to 8 digits unless roundOff is set to False.

New in version 1.5.0.


>>> df = spark.createDataFrame([('1997-02-28 10:30:00', '1996-10-30')], ['date1', 'date2'])
>>>, df.date2).alias('months')).collect()
>>>, df.date2, False).alias('months')).collect()