pyspark.sql.functions.make_timestamp_ltz#

pyspark.sql.functions.make_timestamp_ltz(years, months, days, hours, mins, secs, timezone=None)[source]#

Create the current timestamp with local time zone from years, months, days, hours, mins, secs and timezone fields. If the configuration spark.sql.ansi.enabled is false, the function returns NULL on invalid inputs. Otherwise, it will throw an error instead.

Added in version 3.5.0.

Parameters:

yearsColumn or str: The year to represent, from 1 to 9999. A column that evaluates to an integer.
monthsColumn or str: The month-of-year to represent, from 1 (January) to 12 (December). A column that evaluates to an integer.
daysColumn or str: The day-of-month to represent, from 1 to 31. A column that evaluates to an integer.
hoursColumn or str: The hour-of-day to represent, from 0 to 23. A column that evaluates to an integer.
minsColumn or str: The minute-of-hour to represent, from 0 to 59. A column that evaluates to an integer.
secsColumn or str: The second-of-minute and its micro-fraction to represent, from 0 to 60. The value can be either an integer like 13 , or a fraction like 13.123. If the sec argument equals to 60, the seconds field is set to 0 and 1 minute is added to the final timestamp. A column that evaluates to a decimal.
timezoneColumn or str, optional: The time zone identifier. For example, CET, UTC and etc. A column that evaluates to a string.

Returns:

Column: A new column that contains a current timestamp. Returns a column that evaluates to a timestamp.

See also

pyspark.sql.functions.make_timestamp()
pyspark.sql.functions.make_timestamp_ntz()
pyspark.sql.functions.try_make_timestamp()
pyspark.sql.functions.try_make_timestamp_ltz()
pyspark.sql.functions.try_make_timestamp_ntz()
pyspark.sql.functions.make_time()
pyspark.sql.functions.make_interval()
pyspark.sql.functions.try_make_interval()

Examples

>>> spark.conf.set("spark.sql.session.timeZone", "America/Los_Angeles")

Example 1: Make the current timestamp from years, months, days, hours, mins and secs.

>>> import pyspark.sql.functions as sf
>>> df = spark.createDataFrame([[2014, 12, 28, 6, 30, 45.887, 'CET']],
...     ['year', 'month', 'day', 'hour', 'min', 'sec', 'tz'])
>>> df.select(
...     sf.make_timestamp_ltz(df.year, df.month, 'day', df.hour, df.min, df.sec, 'tz')
... ).show(truncate=False)
+--------------------------------------------------------+
|make_timestamp_ltz(year, month, day, hour, min, sec, tz)|
+--------------------------------------------------------+
|2014-12-27 21:30:45.887                                 |
+--------------------------------------------------------+

Example 2: Make the current timestamp without timezone.

>>> import pyspark.sql.functions as sf
>>> df = spark.createDataFrame([[2014, 12, 28, 6, 30, 45.887, 'CET']],
...     ['year', 'month', 'day', 'hour', 'min', 'sec', 'tz'])
>>> df.select(
...     sf.make_timestamp_ltz(df.year, df.month, 'day', df.hour, df.min, df.sec)
... ).show(truncate=False)
+----------------------------------------------------+
|make_timestamp_ltz(year, month, day, hour, min, sec)|
+----------------------------------------------------+
|2014-12-28 06:30:45.887                             |
+----------------------------------------------------+

>>> spark.conf.unset("spark.sql.session.timeZone")