Add Server-Side Scan Planning Support
@geruh is already working on this.
Since Jan 19, 2026.
Assessment
This issue has not been assessed yet.
Description
Feature Request / Improvement
Now that Java has added server-side scan planning support PR #14480, I believe Python is a great place to integrate this functionality! We have all the building blocks and they are almost brought to completion. I'm creating this issue to track all of the tasks we need to drive it through
Context
We have some open PRs with some needed model changes, but we have pivoted to using our existing models and ensuring they're properly serializable with pydantic.
For example, initially we can work on:
-
Expression Serialization to ensure
BooleanExpressionand subclasses serialize correctly for REST API. Related to @Fokko's work on #2750 and @rambleraptor #2435. -
DataFile Serialization to ensure we can properly deserialize the data/deletefiles from the server response. Open API uses kebab-case (
file-format,file-path) but our models expect snake_case (file_format,file_path).
REST API Endpoints to Implement
Based on the Iceberg REST spec:
POST /v1/{prefix}/namespaces/{namespace}/tables/{table}/plan- Submit scan for planningGET /v1/{prefix}/namespaces/{namespace}/tables/{table}/plan/{plan-id}- Fetch planning resultDELETE /v1/{prefix}/namespaces/{namespace}/tables/{table}/plan/{plan-id}- Cancel planningPOST /v1/{prefix}/namespaces/{namespace}/tables/{table}/tasks- Fetch scan tasks for a plan task
Tasks
Initially we can start with core sync planning and once that's in place we can add the async support as it looks like it exists in https://github.com/apache/iceberg/blob/main/core/src/test/java/org/apache/iceberg/rest/RESTCatalogAdapter.java
Core Sync Planning
- Build on @Fokko's expression work to ensure
Expressionclasses serialize properly with Pydantic.- #2783
- Construct only plan Request/Response models for synchronous planning
- Add support for REST scan to fetch scan tasks replicating
DataScanbehavior - Parse server response to
FileScanTaskobjects (handle Data/DeleteFile construction) - Add
plan_table_scan()methods - Add documentation
Full Scan planning support (Follow-up)
Complete the full scan planning API with async operations and pagination.
- Add the rest of the models for async planning
- Add support for endpoint 2 & 3 to RESTScan
- Add endpoint 4 support to
RestCatalog - Complete documentation with all scenarios
- Dominant language
- Python
- Stars
- 1.1k
- Forks
- 589
- Avg merge
- 2d 4h
- Merged PRs (30d)
- 72
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from apache/iceberg-python
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
apache/iceberg-python#3996 ·
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
apache/iceberg-python#3979 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
apache/iceberg-python#3885 ·
-
[Bug] PyArrowFileIO fails to propagate s3.ssl.ca-cert to pyarrow.fs.S3FileSystem tls_ca_file_path Open
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
apache/iceberg-python#3866 · 1 comment ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
apache/iceberg-python#3836 · 1 comment ·
All issues in apache/iceberg-python
Similar issues
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 90/100
learningequality/ricecooker#747 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
BSData/horus-heresy-3rd-edition#3171 ·
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
run-llama/llama_index#23199 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
KhronosGroup/glTF-Blender-IO#2769 ·