apache / apache/iceberg-python

Add Server-Side Scan Planning Support

Ouverte
#2,775 5 commentaires 5 réactions 1 personne assignée Réclamée par @geruh Voir sur GitHub
Langage dominant
Python
Étoiles
1.1k
Forks
581
Merge moyen
1 j 17 h
PR mergées (30 j)
78

Description

## Feature Request / Improvement

Now that Java has added server-side scan planning support [PR #14480](https://github.com/apache/iceberg/pull/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:

1. Expression Serialization to ensure `BooleanExpression` and subclasses serialize correctly for REST API. Related to @Fokko's work on #2750 and @rambleraptor #2435.

2. 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](https://github.com/apache/iceberg/blob/main/open-api/rest-catalog-open-api.yaml):

1. `POST /v1/{prefix}/namespaces/{namespace}/tables/{table}/plan` - Submit scan for planning
2. `GET /v1/{prefix}/namespaces/{namespace}/tables/{table}/plan/{plan-id}` - Fetch planning result
3. `DELETE /v1/{prefix}/namespaces/{namespace}/tables/{table}/plan/{plan-id}` - Cancel planning
4. `POST /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

- [x] Build on @Fokko's expression work to ensure `Expression` classes serialize properly with Pydantic.
- #2783
- [x] Construct only plan Request/Response models for synchronous planning
- [x] Add support for REST scan to fetch scan tasks replicating `DataScan` behavior
- [x] Parse server response to `FileScanTask` objects (handle Data/DeleteFile construction)
- [x] 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

Guide de contribution

Aucun guide de contribution indexé pour ce dépôt

Évaluation

Cette issue n'a pas encore été évaluée.

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.