search
Search
Login
Unlock 100+ guides
menu
menu
web
search toc
close
Comments
Log in or sign up
Cancel
Post
account_circle
Profile
exit_to_app
Sign out
What does this mean?
Why is this true?
Give me some examples!
search
keyboard_voice
close
Searching Tips
Search for a recipe:
"Creating a table in MySQL"
Search for an API documentation: "@append"
Search for code: "!dataframe"
Apply a tag filter: "#python"
Useful Shortcuts
/ to open search panel
Esc to close search panel
to navigate between search results
d to clear all current filters
Enter to expand content preview
icon_star
Doc Search
icon_star
Code Search Beta
SORRY NOTHING FOUND!
mic
Start speaking...
Voice search is only supported in Safari and Chrome.
Navigate to

PySpark SQL Functions | date_add method

schedule Aug 12, 2023
Last updated
local_offer
PySpark
Tags
mode_heat
Master the mathematics behind data science with 100+ top-tier guides
Start your free 7-days trial now!

PySpark's date_add(-) method adds the specified number of days to a date column.

Parameters

1. start |

The column of starting dates.

2. days | int

The number of days to add.

Return Value

A pyspark.sql.column.Column object.

Examples

Basic usage

Consider the following DataFrame:

df = spark.createDataFrame([["2023-04-20"], ["2023-04-22"]], ["my_date"])
df.show()
+----------+
| my_date|
+----------+
|2023-04-20|
|2023-04-22|
+----------+

To add 5 days to our column:

from pyspark.sql import functions as F
df.select(F.date_add("my_date", 5)).show()
+--------------------+
|date_add(my_date, 5)|
+--------------------+
| 2023-04-25|
| 2023-04-27|
+--------------------+

Adding a column of days to a column of dates

Unfortunately, the date_add(-) method only accepts a constant for the second parameter. To add a column of days to a column of dates, we must take another approach.

To demonstrate, consider the following PySpark DataFrame:

df = spark.createDataFrame([["2023-04-20", 3], ["2023-04-22", 5]], ["my_date", "my_days"])
df.show()
+----------+-------+
| my_date|my_days|
+----------+-------+
|2023-04-20| 3|
|2023-04-22| 5|
+----------+-------+

To add my_days to my_date, supply the following SQL method in the F.expr() method like so:

# Cast to INT first - by default, intgers have type BIGINT (F.expr(-) with raise an error)
df = df.withColumn("my_days", df["my_days"].cast("int"))
df_new = df_new.withColumn("new_date", F.expr("date_add(my_date, my_days)"))
df_new.show()
+----------+-------+----------+
| my_date|my_days| new_date|
+----------+-------+----------+
|2023-04-20| 3|2023-04-23|
|2023-04-22| 5|2023-04-27|
+----------+-------+----------+

The resulting data type of the columns is as follows:

df_new.printSchema()
root
|-- my_date: string (nullable = true)
|-- days: integer (nullable = true)
|-- new_date: date (nullable = true)

Notice how even though my_date is of type string, the resulting new_date is of type date.

robocat
Published by Isshin Inada
Edited by 0 others
Did you find this page useful?
thumb_up
thumb_down
Comment
Citation
Ask a question or leave a feedback...
thumb_up
0
thumb_down
0
chat_bubble_outline
0
settings
Enjoy our search
Hit / to insta-search docs and recipes!