Skip to content

Commit 44a9020

Browse files
committed
[FLINK-23882][docs] Clarify TIMESTAMP WITH TIME ZONE is not supported by Flink SQL
The data types reference presents TIMESTAMP WITH TIME ZONE with full declaration syntax but never states that the type only exists as a logical type and is not usable in Flink SQL yet (tracked by FLINK-20869; the SQL JDBC driver even throws "TIMESTAMP WITH TIME ZONE is not supported, use TIMESTAMP or TIMESTAMP_LTZ instead"). This has repeatedly confused users on the mailing list. Add a warning callout to the English and Chinese data-types reference pages stating the type is unsupported and pointing users to TIMESTAMP_LTZ.
1 parent 2afa8f1 commit 44a9020

2 files changed

Lines changed: 12 additions & 0 deletions

File tree

docs/content.zh/docs/sql/reference/data-types.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -812,6 +812,12 @@ Data type of a timestamp *with* time zone consisting of `year-month-day hour:min
812812
with up to nanosecond precision and values ranging from `0000-01-01 00:00:00.000000000 +14:59` to
813813
`9999-12-31 23:59:59.999999999 -14:59`.
814814

815+
{{< hint warning >}}
816+
`TIMESTAMP WITH TIME ZONE` currently only exists as a logical type and is **not supported** by Flink SQL yet
817+
(tracked by [FLINK-20869](https://issues.apache.org/jira/browse/FLINK-20869)). If you need to retain time zone
818+
information, use `TIMESTAMP_LTZ` instead.
819+
{{< /hint >}}
820+
815821
{{< tabs "timestamps" >}}
816822
{{< tab "SQL/Java/Scala" >}}
817823
Compared to the SQL standard, leap seconds (`23:59:60` and `23:59:61`) are not supported as the semantics

docs/content/docs/sql/reference/data-types.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -820,6 +820,12 @@ Data type of a timestamp *with* time zone consisting of `year-month-day hour:min
820820
with up to nanosecond precision and values ranging from `0000-01-01 00:00:00.000000000 +14:59` to
821821
`9999-12-31 23:59:59.999999999 -14:59`.
822822

823+
{{< hint warning >}}
824+
`TIMESTAMP WITH TIME ZONE` currently only exists as a logical type and is **not supported** by Flink SQL yet
825+
(tracked by [FLINK-20869](https://issues.apache.org/jira/browse/FLINK-20869)). If you need to retain time zone
826+
information, use `TIMESTAMP_LTZ` instead.
827+
{{< /hint >}}
828+
823829
{{< tabs "timestamps" >}}
824830
{{< tab "SQL/Java/Scala" >}}
825831
Compared to the SQL standard, leap seconds (`23:59:60` and `23:59:61`) are not supported as the semantics

0 commit comments

Comments
 (0)