pyspark.sql.functions.try_make_timestamp_ltz#

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

Try to create the current timestamp with local time zone from years, months, days, hours, mins, secs and timezone fields. The function returns NULL on invalid inputs.

Added in version 4.0.0.

Parameters:
yearsColumn or column name

The year to represent, from 1 to 9999. A column that evaluates to an integer.

monthsColumn or column name

The month-of-year to represent, from 1 (January) to 12 (December). A column that evaluates to an integer.

daysColumn or column name

The day-of-month to represent, from 1 to 31. A column that evaluates to an integer.

hoursColumn or column name

The hour-of-day to represent, from 0 to 23. A column that evaluates to an integer.

minsColumn or column name

The minute-of-hour to represent, from 0 to 59. A column that evaluates to an integer.

secsColumn or column name

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 column name, 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, or NULL in case of an error. Returns a column that evaluates to a timestamp.

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.try_make_timestamp_ltz('year', 'month', df.day, df.hour, df.min, df.sec, 'tz')
... ).show(truncate=False)
+------------------------------------------------------------+
|try_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.try_make_timestamp_ltz('year', 'month', df.day, df.hour, df.min, df.sec)
... ).show(truncate=False)
+--------------------------------------------------------+
|try_make_timestamp_ltz(year, month, day, hour, min, sec)|
+--------------------------------------------------------+
|2014-12-28 06:30:45.887                                 |
+--------------------------------------------------------+

Example 3: Make the current timestamp with invalid input.

>>> import pyspark.sql.functions as sf
>>> df = spark.createDataFrame([[2014, 13, 28, 6, 30, 45.887, 'CET']],
...     ['year', 'month', 'day', 'hour', 'min', 'sec', 'tz'])
>>> df.select(
...     sf.try_make_timestamp_ltz('year', 'month', df.day, df.hour, df.min, df.sec)
... ).show(truncate=False)
+--------------------------------------------------------+
|try_make_timestamp_ltz(year, month, day, hour, min, sec)|
+--------------------------------------------------------+
|NULL                                                    |
+--------------------------------------------------------+
>>> spark.conf.unset("spark.sql.session.timeZone")