flink icon indicating copy to clipboard operation
flink copied to clipboard

[FLINK-34147][table-planner] Enhance the java doc of TimestampData to distinguish the different usage of Instant and LocalDateTime

Open swuferhong opened this issue 6 months ago • 2 comments

What is the purpose of the change

Currently, the java docs of TimestampData is ambiguous. TimestampData represents both Instant and LocalDateTime. this class use fromInstant()/toInstant() to convert an Instant from/to TimestampData, and use fromLocalDateTime()/toLocalDateTime() to convert a LocalDateTime from/to TimestampData. This need to be indicated in java docs.

Brief change log

Verifying this change

Does this pull request potentially affect one of the following parts:

  • Dependencies (does it add or upgrade a dependency): no
  • The public API, i.e., is any changed class annotated with @Public(Evolving): no
  • The serializers: no
  • The runtime per-record code paths (performance sensitive): no
  • Anything that affects deployment or recovery: JobManager (and its components), Checkpointing, Kubernetes/Yarn, ZooKeeper: no
  • The S3 file system connector: no

Documentation

  • Does this pull request introduce a new feature? no
  • If yes, how is the feature documented? no docs

swuferhong avatar Feb 20 '24 01:02 swuferhong

CI report:

  • 1e0acf858f5dfa9a029dfc0507d345cdd36a17b3 Azure: SUCCESS
Bot commands The @flinkbot bot supports the following commands:
  • @flinkbot run azure re-run the last Azure build

flinkbot avatar Feb 20 '24 01:02 flinkbot

Hi, @lirui Could you help review this, please?

swuferhong avatar Feb 21 '24 01:02 swuferhong