[FLINK-23882][docs] Clarify TIMESTAMP WITH TIME ZONE is not supported by Flink SQL#28492
Open
Vamsi-klu wants to merge 1 commit into
Open
[FLINK-23882][docs] Clarify TIMESTAMP WITH TIME ZONE is not supported by Flink SQL#28492Vamsi-klu wants to merge 1 commit into
Vamsi-klu wants to merge 1 commit into
Conversation
… 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.
Collaborator
Author
|
This is a docs-only change (en + zh) clarifying that Drafted-by: Claude Code (Opus 4.8) (no human review before posting) |
44a9020 to
de5f8c4
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What is the purpose of the change
The data types reference page documents
TIMESTAMP WITH TIME ZONEwith full declaration syntax (TIMESTAMP(p) WITH TIME ZONE), which makes it look like a usable SQL type. In reality the type currently only exists as a logical type and is not supported by Flink SQL yet — reading/casting it is unimplemented (tracked by FLINK-20869), and the SQL JDBC driver explicitly throws:The missing caveat has repeatedly confused users (see FLINK-23882), who reach for
TIMESTAMP WITH TIME ZONEexpecting it to work and then hit timestamp-correctness surprises.Brief change log
{{< hint warning >}}callout to theTIMESTAMP WITH TIME ZONEsection of the data types reference stating the type only exists as a logical type, is not supported by Flink SQL yet (linking FLINK-20869), and pointing users toTIMESTAMP_LTZwhen time zone information must be retained.content.zh) mirror of the page.Verifying this change
This change is a documentation-only update without test coverage. The claim was verified against the codebase:
FlinkResultSetrejectsTIMESTAMP_WITH_TIME_ZONE, andCastFunctionITCaseleaves the casts unimplemented pending FLINK-20869. The note reuses the{{< hint warning >}}shortcode already present elsewhere on the same page.Does this pull request potentially affect one of the following parts:
@Public(Evolving): noDocumentation
This documentation change was prepared with AI assistance (Claude Code).