Help Center/ Data Lake Insight/ SQL Syntax Reference (To Be Offline)/ Spark SQL Syntax Reference (Unavailable Soon)/ Built-in Functions/ Date Functions/ from_utc_timestamp
Updated on 2023-10-25 GMT+08:00
View PDF
Share

from_utc_timestamp

This function is used to convert a UTC timestamp to a UNIX timestamp in a given time zone.

Syntax

from_utc_timestamp(string timestamp, string timezone)

Parameters

Table 1 Parameters

Parameter

Mandatory

Type

Description

timestamp

Yes

DATE

STRING

TINYINT

SMALLINT

INT

BIGINT

Time to be converted

Date value of the DATE or STRING type, or timestamp of the TINYINT, SMALLINT, INT, or BIGINT type.

The following formats are supported:

yyyy-mm-dd

yyyy-mm-dd hh:mi:ss

yyyy-mm-dd hh:mi:ss.ff3

timezone

Yes

STRING

Time zone where the time to be converted belongs

Return Values

The return value is of the TIMESTAMP type.

  • If the value of timestamp is not of the DATE or STRING type, the error message "data type mismatch" is displayed.
  • If the value of timestamp is of the DATE or STRING type but is not in one of the supported formats, NULL is returned.
  • If the value of timestamp is NULL, NULL is returned.
  • If the value of timezone is NULL, NULL is returned.

Example Code

The value 1691978400000 is returned, indicating 2023-08-14 10:00:00.

select from_utc_timestamp('2023-08-14 17:00:00','PST');

The value 1691917200000 is returned, indicating 2023-08-13 17:00:00.

select from_utc_timestamp(date '2023-08-14 00:00:00','PST');

The value NULL is returned.

select from_utc_timestamp('2023-08-13',null);
Parent topic: Date Functions