feat: Add models for rest scan planning #2861
Open
+658
−0
Conversation
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
kevinjqliu
approved these changes
Dec 24, 2025
Contributor
kevinjqliu
left a comment
kevinjqliu
left a comment
There was a problem hiding this comment.
LGTM! Agreed with the DataFile serialization problem. We can refactor later on and unify the representation.
For now lets move this forward. Excited to see scan planning in action for pyiceberg 😄
| """Position delete file from REST API.""" | ||
|
|
||
| content: Literal["position-deletes"] = Field(default="position-deletes") | ||
| referenced_data_file: str | None = Field(alias="referenced-data-file", default=None) |
Contributor
There was a problem hiding this comment.
Suggested change
| referenced_data_file: str | None = Field(alias="referenced-data-file", default=None) |
PositionDeleteFile doesnt have this
https://github.com/apache/iceberg/blob/0651b8913d27c3b1c9aca4a9609bec521905fb36/open-api/rest-catalog-open-api.yaml#L4450-L4466
|
|
||
| snapshot_id: int | None = Field(alias="snapshot-id", default=None) | ||
| select: list[str] | None = Field(default=None) | ||
| filter: BooleanExpression | None = Field(default=None) |
Contributor
There was a problem hiding this comment.
Suggested change
| filter: BooleanExpression | None = Field(default=None) | |
| filter: BooleanExpression | None = Field(default=None) | |
| min_rows_requested: int | None = Field(alias="min-rows-requested", default=None) |
missing min_rows_requested https://github.com/apache/iceberg/blob/0651b8913d27c3b1c9aca4a9609bec521905fb36/open-api/rest-catalog-open-api.yaml#L4483-L4507
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
related to #2775 and #2792
Rationale for this change
This PR adds the Pydantic models for the REST catalog server-side scan planning API focusing on the synchronous use cases first.
There's some redundancy here with things like
RESTDataFilevs the existingDataFilein the manifest module.As mentioned in #2792 the manifest logic with encoding/decoding is dependency on Avro. Rather than trying to solve that unification problem upfront and blocking ourselves, I went with separate REST pydantic types for now. The plan is to eventually add conversion methods or a common interface so these can work together with our existing scan task and content file types.
The models and tests here align with the Java implementation.
Are these changes tested?
Yes, added tests and works against POC
Are there any user-facing changes?
No