This is an automated email from the ASF dual-hosted git repository.
kevinjqliu pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/iceberg-python.git
The following commit(s) were added to refs/heads/main by this push:
new 739373fcd REST: Rename rest-scan-planning-enabled to
scan-planning-mode (#3376)
739373fcd is described below
commit 739373fcdf68d01ab7ab6d577199cdc2058eb74e
Author: Yuya Ebihara <[email protected]>
AuthorDate: Tue May 19 23:11:41 2026 +0900
REST: Rename rest-scan-planning-enabled to scan-planning-mode (#3376)
# Rationale for this change
Boolean properties should be avoided as much as possible.
We may consider introducing a new scan planning mode in the future.
The Java implementation has already changed from
`rest-scan-planning-enabled` to `scan-planning-mode` in
https://github.com/apache/iceberg/pull/15572.
## Are these changes tested?
Yes.
## Are there any user-facing changes?
Rename `rest-scan-planning-enabled` to `scan-planning-mode`.
<!-- In the case of user-facing changes, please add the changelog label.
-->
---
pyiceberg/catalog/rest/__init__.py | 14 +++++++++-----
tests/catalog/test_rest.py | 9 +++++----
2 files changed, 14 insertions(+), 9 deletions(-)
diff --git a/pyiceberg/catalog/rest/__init__.py
b/pyiceberg/catalog/rest/__init__.py
index 7fa81312d..39954ef56 100644
--- a/pyiceberg/catalog/rest/__init__.py
+++ b/pyiceberg/catalog/rest/__init__.py
@@ -225,6 +225,11 @@ class IdentifierKind(Enum):
VIEW = "view"
+class ScanPlanningMode(Enum):
+ CLIENT = "client"
+ SERVER = "server"
+
+
ACCESS_DELEGATION_DEFAULT = "vended-credentials"
AUTHORIZATION_HEADER = "Authorization"
BEARER_PREFIX = "Bearer"
@@ -255,8 +260,8 @@ OAUTH2_SERVER_URI = "oauth2-server-uri"
SNAPSHOT_LOADING_MODE = "snapshot-loading-mode"
AUTH = "auth"
CUSTOM = "custom"
-REST_SCAN_PLANNING_ENABLED = "rest-scan-planning-enabled"
-REST_SCAN_PLANNING_ENABLED_DEFAULT = False
+SCAN_PLANNING_MODE = "scan-planning-mode"
+SCAN_PLANNING_MODE_DEFAULT = ScanPlanningMode.CLIENT.value
# for backwards compatibility with older REST servers where it can be assumed
that a particular
# server supports view endpoints but doesn't send the "endpoints" field in the
ConfigResponse
VIEW_ENDPOINTS_SUPPORTED = "view-endpoints-supported"
@@ -480,9 +485,8 @@ class RestCatalog(Catalog):
@override
def supports_server_side_planning(self) -> bool:
"""Check if the catalog supports server-side scan planning."""
- return Capability.V1_SUBMIT_TABLE_SCAN_PLAN in
self._supported_endpoints and property_as_bool(
- self.properties, REST_SCAN_PLANNING_ENABLED,
REST_SCAN_PLANNING_ENABLED_DEFAULT
- )
+ scan_planning_mode =
ScanPlanningMode(self.properties.get(SCAN_PLANNING_MODE,
SCAN_PLANNING_MODE_DEFAULT))
+ return Capability.V1_SUBMIT_TABLE_SCAN_PLAN in
self._supported_endpoints and scan_planning_mode == ScanPlanningMode.SERVER
@retry(**_RETRY_ARGS)
def _plan_table_scan(self, identifier: str | Identifier, request:
PlanTableScanRequest) -> PlanningResponse:
diff --git a/tests/catalog/test_rest.py b/tests/catalog/test_rest.py
index 2adfe9f06..df2f96a39 100644
--- a/tests/catalog/test_rest.py
+++ b/tests/catalog/test_rest.py
@@ -42,6 +42,7 @@ from pyiceberg.catalog.rest import (
Endpoint,
HttpMethod,
RestCatalog,
+ ScanPlanningMode,
)
from pyiceberg.exceptions import (
AuthorizationExpiredError,
@@ -2546,7 +2547,7 @@ class TestRestCatalogClose:
"rest",
uri=TEST_URI,
token=TEST_TOKEN,
- **{"rest-scan-planning-enabled": "true"},
+ **{"scan-planning-mode": ScanPlanningMode.SERVER.value},
)
assert catalog.supports_server_side_planning() is True
@@ -2562,7 +2563,7 @@ class TestRestCatalogClose:
"rest",
uri=TEST_URI,
token=TEST_TOKEN,
- **{"rest-scan-planning-enabled": "true"},
+ **{"scan-planning-mode": ScanPlanningMode.SERVER.value},
)
assert catalog.supports_server_side_planning() is False
@@ -2572,7 +2573,7 @@ class TestRestCatalogClose:
"rest",
uri=TEST_URI,
token=TEST_TOKEN,
- **{"rest-scan-planning-enabled": "false"},
+ **{"scan-planning-mode": ScanPlanningMode.CLIENT.value},
)
assert catalog.supports_server_side_planning() is False
@@ -2581,7 +2582,7 @@ class TestRestCatalogClose:
rest_mock.get(
f"{TEST_URI}v1/config",
json={
- "defaults": {"rest-scan-planning-enabled": "true"},
+ "defaults": {"scan-planning-mode": "server"},
"overrides": {},
"endpoints": ["POST
/v1/{prefix}/namespaces/{namespace}/tables/{table}/plan"],
},
