Skip to content

docs: update supported instant time formats for incremental and time travel queries #18442

@yaojiejia

Description

@yaojiejia

Task Description

What needs to be done:

Update the Hudi documentation site to document the supported timestamp input formats for the following config options:

  • hoodie.datasource.read.begin.instanttime
  • hoodie.datasource.read.end.instanttime
  • as.of.instant

The following formats should be documented for each:

Format Example
yyyyMMddHHmmss 20250101080000
yyyyMMddHHmmssSSS 20250101080000000
yyyy-MM-dd 2025-01-02
yyyy-MM-dd HH:mm:ss[.SSS] 2025-01-02 03:04:56.789
yyyy-MM-ddTHH:mm:ss[.SSS] 2025-01-02T03:04:56.789
Epoch seconds (10-digit number) 1735689600
Epoch millis (13-digit number) 1735689600000

Additional notes:

  • Values that don't match any supported format now fail fast with an IllegalArgumentException.
  • For begin.instanttime, the sentinel value "earliest" is also accepted.

Why this task is needed:

#17152 has already closed and this issue will update the docs for this change

Task Type

Code improvement/refactoring

Related Issues

Parent feature issue: (if applicable ) #17152
Related issues:
NOTE: Use Relationships button to add parent/blocking issues after issue is created.

Metadata

Metadata

Assignees

No one assigned

    Labels

    type:devtaskDevelopment tasks and maintenance work

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions