Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Conversation

@geruh
Copy link
Contributor

@geruh geruh commented Dec 20, 2025

closes to #2847

Rationale for this change

This PR adds the server endpoint capabilities support, aligning with the Java implementation. While working on the REST scanning support, we need to know if a server supports specific capabilities before making any calls. So this PR also adds some extra support for the current implementation of PI iceberg REST catalog.

The REST catalog will now parse the endpoints field from the config call to determine server capabilities. When a server doesn't respond, we have fallback logic that matches the behavior of Java's rest catalog. The View endpoints are conditionally added to the default with the config property as well.

Are these changes tested?

Added unit tests and tested with the iceberg rest fixture.

Are there any user-facing changes?

Yes added config and alignment with java impl.

cc: @kevinjqliu @Fokko

@kevinjqliu
Copy link
Contributor

wdyt about adding integration tests against the iceberg-rest-fixture?

Running the integration test infra gives me this response on http://localhost:8181/v1/config

{
  "defaults": {},
  "overrides": { "namespace-separator": "%2E" },
  "endpoints":
    [
      "POST v1/oauth/tokens",
      "POST https://auth-server.com/token",
      "GET v1/config",
      "GET /v1/{prefix}/namespaces",
      "POST /v1/{prefix}/namespaces",
      "HEAD /v1/{prefix}/namespaces/{namespace}",
      "GET /v1/{prefix}/namespaces/{namespace}",
      "DELETE /v1/{prefix}/namespaces/{namespace}",
      "POST /v1/{prefix}/namespaces/{namespace}/properties",
      "GET /v1/{prefix}/namespaces/{namespace}/tables",
      "POST /v1/{prefix}/namespaces/{namespace}/tables",
      "HEAD /v1/{prefix}/namespaces/{namespace}/tables/{table}",
      "GET /v1/{prefix}/namespaces/{namespace}/tables/{table}",
      "POST /v1/{prefix}/namespaces/{namespace}/register",
      "POST /v1/{prefix}/namespaces/{namespace}/tables/{table}",
      "DELETE /v1/{prefix}/namespaces/{namespace}/tables/{table}",
      "POST /v1/{prefix}/tables/rename",
      "POST /v1/{prefix}/namespaces/{namespace}/tables/{table}/metrics",
      "POST /v1/{prefix}/transactions/commit",
      "GET /v1/{prefix}/namespaces/{namespace}/views",
      "HEAD /v1/{prefix}/namespaces/{namespace}/views/{view}",
      "GET /v1/{prefix}/namespaces/{namespace}/views/{view}",
      "POST /v1/{prefix}/namespaces/{namespace}/views",
      "POST /v1/{prefix}/namespaces/{namespace}/views/{view}",
      "POST /v1/{prefix}/views/rename",
      "DELETE /v1/{prefix}/namespaces/{namespace}/views/{view}",
      "POST /v1/{prefix}/namespaces/{namespace}/tables/{table}/plan",
      "GET /v1/{prefix}/namespaces/{namespace}/tables/{table}/plan/{plan-id}",
      "POST /v1/{prefix}/namespaces/{namespace}/tables/{table}/tasks",
      "DELETE /v1/{prefix}/namespaces/{namespace}/tables/{table}/plan/{plan-id}",
    ],
}

Copy link
Contributor

@kevinjqliu kevinjqliu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! Thanks for adding this feature.
The PR looks good and is throughly tested. I just have a few nit comments.
Feel free to address here or as a follow up PR

pyiceberg/catalog/rest/__init__.py Outdated Show resolved Hide resolved
NotImplementedError: If the endpoint is not supported.
"""
if endpoint not in self._supported_endpoints:
raise NotImplementedError(f"Server does not support endpoint: {endpoint}")
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: java throws UnsupportedOperationException here

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There really isn't an exact equivalent for java's UnsupportedOperationException exception in python. I went with NotImplementedError since it's the closest. Alternatively, we can go with RuntimeException.

pyiceberg/catalog/rest/__init__.py Outdated Show resolved Hide resolved
pyiceberg/catalog/rest/__init__.py Outdated Show resolved Hide resolved
fetch_scan_tasks: str = "namespaces/{namespace}/tables/{table}/tasks"


class Capability:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: maybe we can refactor the Endpoints class and consolidate this class

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Initially I went with this approach, but it felt like it just introduced some confusion. Since the Capabilities seem more like a config to flag support, and the resource paths or Endpoints are similar but adding the prefix to the url would make the url construction complex because prefix is optional.

pyiceberg/catalog/rest/__init__.py Outdated Show resolved Hide resolved
pyiceberg/catalog/rest/__init__.py Show resolved Hide resolved
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: wdyt of adding the endpoints in the rest_mock here
that way we dont need to add it to each test.

We can modify it when testing specific cases, such as when an older server does not return the view endpoints, or when testing the endpoint response directly

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

Morty Proxy This is a proxified and sanitized view of the page, visit original site.