-
Notifications
You must be signed in to change notification settings - Fork 212
docs: doc the requirement for ParquetHandler to do type widening #3313
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
dengsh12
wants to merge
2
commits into
delta-io:main
Choose a base branch
from
dengsh12:docs/parquet-reader-type-widening
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+16
−7
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change | ||||||
|---|---|---|---|---|---|---|---|---|
|
|
@@ -792,13 +792,22 @@ pub trait ParquetHandler: AsAny { | |||||||
| /// | ||||||||
| /// # Type coercion | ||||||||
| /// | ||||||||
| /// A matched Parquet column whose physical type differs from the `physical_schema` | ||||||||
| /// [`StructField`] must be coerced to the requested type. In particular, timestamp columns MUST | ||||||||
| /// be normalized to the protocol specified microsecond precision: a `TIMESTAMP(MILLIS)` (or | ||||||||
| /// any other non-microsecond unit) column read into a `TIMESTAMP` / `TIMESTAMP_NTZ` field | ||||||||
| /// must be rescaled to microseconds (a finer unit such as nanosecond is truncated). The | ||||||||
| /// default engine does this via `arrow::compute::cast` while reordering columns to the | ||||||||
| /// requested schema. | ||||||||
| /// When `physical_schema` requests a type different from the matched Parquet column, the reader | ||||||||
| /// must coerce it to the requested type when the conversion is allowed by the [Delta protocol | ||||||||
| /// type widening rules]. Examples include `INTEGER` -> `LONG`, `FLOAT` -> `DOUBLE`, and `DATE` | ||||||||
| /// -> `TIMESTAMP_NTZ`. See the protocol for the complete list. | ||||||||
|
Comment on lines
+795
to
+798
Collaborator
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. DefaultEngine does this, but some engine has not implemented this -- will inform them |
||||||||
| /// | ||||||||
| /// Kernel additionally requires readers to support `INT32` -> `DATE` and `INT64` -> | ||||||||
| /// `TIMESTAMP` / `TIMESTAMP_NTZ` conversions for checkpoint `stats_parsed` and | ||||||||
| /// `partitionValues_parsed` fields. | ||||||||
| /// | ||||||||
| /// Timestamp columns MUST be normalized to the protocol specified microsecond precision: a | ||||||||
| /// `TIMESTAMP(MILLIS)` (or any other non-microsecond unit) column read into a `TIMESTAMP` / | ||||||||
| /// `TIMESTAMP_NTZ` field must be rescaled to microseconds (a finer unit such as nanosecond is | ||||||||
| /// truncated). The default engine does this via `arrow::compute::cast` while reordering columns | ||||||||
| /// to the requested schema. | ||||||||
|
Comment on lines
+807
to
+808
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. nit:
Suggested change
|
||||||||
| /// | ||||||||
| /// [Delta protocol type widening rules]: https://github.com/delta-io/delta/blob/master/PROTOCOL.md#type-widening | ||||||||
| /// | ||||||||
| /// # Metadata Columns | ||||||||
| /// | ||||||||
|
|
||||||||
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nit1 The examples INTEGER -> LONG, FLOAT -> DOUBLE, and DATE -> TIMESTAMP_NTZ sit directly under the type widening rules link, while the next paragraph lists INT32 -> DATE and INT64 -> TIMESTAMP/TIMESTAMP_NTZ as extra Kernel requirements. A reader could infer these coercions are gated on the type-widening table feature rather than being reader-side coercions needed to materialize the requested physical_schema. Raised by: maintainer-codex-reviewer. Suggested fix: add a short clause noting these coercions are required whenever physical_schema asks for a compatible type and are not conditional on the type-widening feature being enabled.