You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@iceberg.apache.org by "talatuyarer (via GitHub)" <gi...@apache.org> on 2026/09/03 17:49:21 UTC

[PR] Docs: Add dedicated page for REST Catalog documentation [iceberg]

talatuyarer opened a new pull request, #17940:
URL: https://github.com/apache/iceberg/pull/17940

   I know We have the REST Catalog Spec page and the OpenAPI definition, but those target server implementers, and the Catalogs section documents JDBC, Nessie, Hive, and Glue while saying nothing about how to actually use a REST catalog. 
   
   I thought it could be good to add `docs/docs/rest-catalog.md` with general configuration examples for Java, Spark, and Flink and short prose sections on the protocol features that have no other home in the docs: endpoint discovery, multi-table transactions, credential vending and remote signing, server-side scan planning, ETag-based freshness and lazy snapshot loading, idempotent commit retries, pagination, and metrics reporting.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For additional commands, e-mail: issues-help@iceberg.apache.org


Re: [PR] Docs: Add dedicated page for REST Catalog documentation [iceberg]

Posted by "RussellSpitzer (via GitHub)" <gi...@apache.org>.
RussellSpitzer commented on code in PR #17940:
URL: https://github.com/apache/iceberg/pull/17940#discussion_r3928308462


##########
docs/docs/rest-catalog.md:
##########
@@ -0,0 +1,228 @@
+---
+title: "REST Catalog"
+---
+<!--
+ - Licensed to the Apache Software Foundation (ASF) under one or more
+ - contributor license agreements.  See the NOTICE file distributed with
+ - this work for additional information regarding copyright ownership.
+ - The ASF licenses this file to You under the Apache License, Version 2.0
+ - (the "License"); you may not use this file except in compliance with
+ - the License.  You may obtain a copy of the License at
+ -
+ -   http://www.apache.org/licenses/LICENSE-2.0
+ -
+ - Unless required by applicable law or agreed to in writing, software
+ - distributed under the License is distributed on an "AS IS" BASIS,
+ - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ - See the License for the specific language governing permissions and
+ - limitations under the License.
+ -->
+
+# Iceberg REST Catalog
+
+The REST catalog is a client for any catalog service that implements the

Review Comment:
   I would start out by defining what an Iceberg REST Catalog (server) is in this paragraph. So really just drop the first part of this line. 
   



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For additional commands, e-mail: issues-help@iceberg.apache.org


Re: [PR] Docs: Add dedicated page for REST Catalog documentation [iceberg]

Posted by "RussellSpitzer (via GitHub)" <gi...@apache.org>.
RussellSpitzer commented on code in PR #17940:
URL: https://github.com/apache/iceberg/pull/17940#discussion_r3936609182


##########
docs/docs/rest-catalog.md:
##########
@@ -0,0 +1,166 @@
+---
+title: "REST Catalog"
+---
+<!--
+ - Licensed to the Apache Software Foundation (ASF) under one or more
+ - contributor license agreements.  See the NOTICE file distributed with
+ - this work for additional information regarding copyright ownership.
+ - The ASF licenses this file to You under the Apache License, Version 2.0
+ - (the "License"); you may not use this file except in compliance with
+ - the License.  You may obtain a copy of the License at
+ -
+ -   http://www.apache.org/licenses/LICENSE-2.0
+ -
+ - Unless required by applicable law or agreed to in writing, software
+ - distributed under the License is distributed on an "AS IS" BASIS,
+ - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ - See the License for the specific language governing permissions and
+ - limitations under the License.
+ -->
+
+# Iceberg REST Catalog
+
+An Iceberg REST catalog is any catalog service that implements the
+[Iceberg REST Catalog API specification](../../rest-catalog-spec.md). Instead of
+requiring a catalog-specific client in every engine and language, the catalog
+logic lives behind an HTTP API, and a single client implementation works with
+any compliant server.
+
+This page describes how to connect to a REST catalog from engines. For the protocol's features see the
+[REST Catalog Protocol](rest-protocol.md) concept page; for the protocol
+definition itself, see the [spec page](../../rest-catalog-spec.md). To try the
+protocol locally, the community publishes the
+[`apache/iceberg-rest-fixture`](https://hub.docker.com/r/apache/iceberg-rest-fixture)
+Docker image, which serves the REST API backed by an in-memory catalog; see its
+[README](https://github.com/apache/iceberg/blob/main/docker/iceberg-rest-fixture/README.md)
+for how to run and configure it, or the
+[Spark quickstart](../../spark-quickstart.md).
+
+## Configuration
+
+Connecting to a REST catalog requires at minimum a `uri` pointing at the
+service. The following properties configure the client side of the
+connection; the
+[common catalog properties](catalog-properties.md) (such as `warehouse` and
+`io-impl`) apply as well. Note that the server can adjust this configuration
+at connection time through
+[endpoint discovery](rest-protocol.md#endpoint-discovery-and-server-provided-configuration).
+
+| Property                              | Default           | Description                                                                                                                                                                                      |
+|---------------------------------------|-------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `snapshot-loading-mode`               | `ALL`             | Controls how snapshots are loaded from the REST server. Supported values: `ALL` (load all snapshots), `REFS` (load only referenced snapshots).                                                  |
+| `rest-metrics-reporting-enabled`      | `true`            | Whether to enable metrics reporting to the REST server.                                                                                                                                          |
+| `view-endpoints-supported`            | `false`           | For backwards compatibility with older REST servers. Set to `true` if the server supports view endpoints but doesn't send the `endpoints` field in the ConfigResponse.                          |
+| `rest-page-size`                      | null              | The page size to use when listing namespaces, tables, or other paginated resources.                                                                                                              |
+| `namespace-separator`                 | `%1F`             | The separator character used for namespace levels when communicating with the REST server.                                                                                                       |
+| `scan-planning-mode`                  | `CLIENT`          | Controls where scan planning is performed. Supported values: `CLIENT` (client-side planning), `SERVER` (server-side planning). Can be overridden per-table by the server in LoadTableResponse. |
+| `rest.client.max-retries`           | `5`     | Maximum number of times to retry a failed HTTP request, using exponential backoff between attempts.                                                                                                                                                                                                                 |
+| `rest.client.max-connections`       | `100`   | Maximum total number of connections in the HTTP client connection pool. A JVM system property with the same name takes precedence over this catalog property.                                                                                                                                                       |
+| `rest.client.connections-per-route` | `100`   | Maximum number of pooled connections per route.                                                                                                                                                                                                                                                                     |
+| `rest.client.connection-timeout-ms` | null    | Timeout in milliseconds for establishing a connection to the server. If not set, the HTTP client library default is used.                                                                                                                                                                                           |
+| `rest.client.socket-timeout-ms`     | null    | Socket timeout in milliseconds for awaiting data on a connection. If not set, the HTTP client library default is used.                                                                                                                                                                                              |
+| `rest.client.user-agent`            | null    | Custom `User-Agent` header value to send with each request. If not set, the HTTP client library default is used.                                                                                                                                                                                                    |
+| `rest.client.proxy.hostname`        | null    | Hostname of an HTTP proxy to route requests through. Must be set together with `rest.client.proxy.port` to take effect.                                                                                                                                                                                             |
+| `rest.client.proxy.port`            | null    | Port of the HTTP proxy. Must be set together with `rest.client.proxy.hostname` to take effect.                                                                                                                                                                                                                      |
+| `rest.client.proxy.username`        | null    | Username for proxy authentication. Must be set together with `rest.client.proxy.password` to take effect, and only applies when the proxy hostname and port are configured. Only Basic authentication is supported.                                                                                                 |
+| `rest.client.proxy.password`        | null    | Password for proxy authentication. Must be set together with `rest.client.proxy.username` to take effect.                                                                                                                                                                                                           |
+| `rest.client.tls.configurer-impl`   | null    | A custom `org.apache.iceberg.rest.auth.TLSConfigurer` implementation to customize TLS settings such as the `SSLContext`, hostname verifier, supported protocols, and cipher suites. The implementation must have a no-arg constructor and is initialized with the catalog properties. If it returns a non-null hostname verifier, that verifier replaces the built-in JSSE hostname verification. |
+
+### Table cache properties
+
+The following properties configure the table cache used for freshness-aware table loading. Note, this cache is different from the one that can be configured at catalog level in general.
+
+| Property                                 | Default           | Description                                                                            |
+|-------------------------------------------|-------------------|------------------------------------------------------------------------------------------|
+| `rest-table-cache.expire-after-write-ms` | `300000` (5 min)  | Time in milliseconds after which cached table entries expire.                          |
+| `rest-table-cache.max-entries`           | `100`             | Maximum number of table entries to cache.                                              |
+
+## Authentication
+
+Most deployments require authentication, which is specific to the catalog
+service. The following catalog properties configure the potential
+authentication mechanisms: Basic, OAuth2, SigV4, and Google.
+
+### REST auth properties
+
+| Property                             | Default          | Description                                                                                                       |
+|--------------------------------------|------------------|-------------------------------------------------------------------------------------------------------------------|
+| `rest.auth.type`                     | `none`           | Authentication mechanism for REST catalog access. Supported values: `none`, `basic`, `oauth2`, `sigv4`, `google`. |
+| `rest.auth.basic.username`           | null             | Username for Basic authentication. Required if `rest.auth.type` = `basic`.                                        |
+| `rest.auth.basic.password`           | null             | Password for Basic authentication. Required if `rest.auth.type` = `basic`.                                        |
+| `rest.auth.sigv4.delegate-auth-type` | `oauth2`         | Auth type to delegate to after `sigv4` signing.                                                                   |
+
+### OAuth2 auth properties
+Required and optional properties to include while using `oauth2` authentication
+
+| Property                | Default           | Description                                                                                                                                                           |
+|-------------------------|-------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `token`                 | null              | A Bearer token to interact with the server. Either `token` or `credential` is required.                                                                               |
+| `credential`            | null              | Credential string in the form of `client_id:client_secret` to exchange for a token in the OAuth2 client credentials flow. Either `token` or `credential` is required. |
+| `oauth2-server-uri`     | `v1/oauth/tokens` | OAuth2 token endpoint URI. Required if the REST catalog is not the OAuth2 authentication server.                                                                      |
+| `token-expires-in-ms`   | 3600000 (1 hour)  | Time in milliseconds after which a bearer token is considered expired. Used to decide when to refresh or re-exchange a token.                                         |
+| `token-refresh-enabled` | true              | Determines whether tokens are automatically refreshed when expiration details are available.                                                                          |
+| `token-exchange-enabled`| true              | Determines whether to use the token exchange flow to acquire new tokens. Disabling this will allow fallback to the client credential flow.                            |
+| `scope`                 | `catalog`         | Additional scope for `oauth2`.                                                                                                                                        |
+| `audience`              | null              | Optional param to specify token `audience`                                                                                                                            |
+| `resource`              | null              | Optional param to specify `resource`                                                                                                                                  |
+
+### SigV4 auth properties
+Required and optional properties to include while using `sigv4` authentication
+
+| Property                             | Default          | Description                                                                                                       |
+|--------------------------------------|------------------|-------------------------------------------------------------------------------------------------------------------|
+| `rest.signing-region`                     | null           | Region to be used by the SigV4 protocol for signing requests. |
+| `rest.signing-name`                       | `execute-api`  | The service name to be used by the SigV4 protocol for signing requests. |
+| `rest.access-key-id`                      | null           | Configure the static access key ID used for SigV4 signing. |
+| `rest.secret-access-key`                  | null           | Configure the static secret access key used for SigV4 signing. |
+| `rest.session-token`                      | null           | Configure the static session token used for SigV4. |
+| `client.credentials-provider`             | null           | When configured, REST catalog requests will use this provider to get AWS credentials to sign the request instead of reading the default credential chain. |
+| `client.assume-role.arn`            | null, requires user input                | ARN of the role to assume, e.g. arn:aws:iam::123456789:role/myRoleToAssume  |
+| `client.assume-role.region`         | null, requires user input                | All AWS clients except the STS client will use the given region instead of the default region chain  |
+| `client.assume-role.external-id`    | null                                     | An optional [external ID](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html)  |
+| `client.assume-role.timeout-sec`    | 1 hour                                   | Timeout of each assume role session. At the end of the timeout, a new set of role session credentials will be fetched through an STS client.  |
+
+When `rest.access-key-id`, `rest.secret-access-key`, and optionally `rest.session-token` are configured, REST Catalog requests will be signed with the provided basic or session credentials instead of using the default credential chain. If `rest.session-token` is set, session credential is used, otherwise basic credential is used.
+
+When basic or session credentials are provided, the provided credentials will be used instead of `client.credentials-provider`. `client.credentials-provider` must contain a static `create` or `create(Map<String, String>)` method to be used by REST catalog requests.
+
+When `client.assume-role.arn` and `client.assume-role.region` are configured, Iceberg will assume the role using the default credential chain to sign REST catalog requests. These parameters will have no effect if `rest.access-key-id`, `rest.secret-access-key`, or `client.credentials-provider` are configured.
+
+### Google auth properties
+Required and optional properties to include while using `google` authentication
+
+| Property                   | Default                                          | Description                                      |
+|----------------------------|--------------------------------------------------|--------------------------------------------------|
+| `gcp.auth.credentials-path`| Application Default Credentials (ADC)            | Path to a service account JSON key file.         |
+| `gcp.auth.credentials-json` | Application Default Credentials (ADC)            | JSON string of a service account credential.     |
+| `gcp.auth.scopes`          | `https://www.googleapis.com/auth/cloud-platform` | Comma-separated list of OAuth scopes to request. |
+
+## Examples

Review Comment:
   I would put these examples at the top, just because it's probably what everyone is thinking about first



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For additional commands, e-mail: issues-help@iceberg.apache.org


Re: [PR] Docs: Add dedicated page for REST Catalog documentation [iceberg]

Posted by "RussellSpitzer (via GitHub)" <gi...@apache.org>.
RussellSpitzer commented on code in PR #17940:
URL: https://github.com/apache/iceberg/pull/17940#discussion_r3928380826


##########
docs/docs/rest-catalog.md:
##########
@@ -0,0 +1,228 @@
+---
+title: "REST Catalog"
+---
+<!--
+ - Licensed to the Apache Software Foundation (ASF) under one or more
+ - contributor license agreements.  See the NOTICE file distributed with
+ - this work for additional information regarding copyright ownership.
+ - The ASF licenses this file to You under the Apache License, Version 2.0
+ - (the "License"); you may not use this file except in compliance with
+ - the License.  You may obtain a copy of the License at
+ -
+ -   http://www.apache.org/licenses/LICENSE-2.0
+ -
+ - Unless required by applicable law or agreed to in writing, software
+ - distributed under the License is distributed on an "AS IS" BASIS,
+ - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ - See the License for the specific language governing permissions and
+ - limitations under the License.
+ -->
+
+# Iceberg REST Catalog
+
+The REST catalog is a client for any catalog service that implements the
+[Iceberg REST Catalog API specification](../../rest-catalog-spec.md). Instead of
+requiring a catalog-specific client in every engine and language, the catalog
+logic lives behind an HTTP API, and a single client implementation works with
+any compliant server.
+
+This page describes how to configure the REST catalog client and the protocol
+features it supports. For the protocol definition itself, see the
+[spec page](../../rest-catalog-spec.md). To try the protocol locally, the
+community publishes the
+[`apache/iceberg-rest-fixture`](https://hub.docker.com/r/apache/iceberg-rest-fixture)
+Docker image, which serves the REST API backed by an in-memory catalog; see its
+[README](https://github.com/apache/iceberg/blob/main/docker/iceberg-rest-fixture/README.md)
+for how to run and configure it, or the
+[Spark quickstart](../../spark-quickstart.md).
+
+## Configuring a REST catalog
+
+A REST catalog needs at minimum a `uri` pointing at the server. Most
+deployments also configure authentication; see
+[REST auth properties](catalog-properties.md#auth-properties) for the
+supported mechanisms (Basic, OAuth2, SigV4, and Google). The full list of
+client properties is in
+[REST catalog properties](catalog-properties.md#rest-catalog-properties).
+
+### Java
+
+```java
+import java.util.HashMap;
+import java.util.Map;
+import org.apache.iceberg.CatalogProperties;
+import org.apache.iceberg.rest.RESTCatalog;
+
+Map<String, String> properties = new HashMap<>();
+properties.put(CatalogProperties.URI, "https://catalog-service/api/catalog");
+
+RESTCatalog catalog = new RESTCatalog();
+catalog.initialize("prod", properties);
+```
+
+Engines that load catalogs through `CatalogUtil.buildIcebergCatalog` select the
+REST catalog with `type=rest`.
+
+### Spark
+
+```ini
+spark.sql.catalog.prod          = org.apache.iceberg.spark.SparkCatalog
+spark.sql.catalog.prod.type     = rest
+spark.sql.catalog.prod.uri      = https://catalog-service/api/catalog
+```
+
+See [Spark catalog configuration](spark-configuration.md#catalog-configuration)
+for details.
+
+### Flink
+
+```sql
+CREATE CATALOG prod WITH (
+  'type'='iceberg',
+  'catalog-type'='rest',
+  'uri'='https://catalog-service/api/catalog'
+);
+```
+
+See the [Flink catalog documentation](flink.md#rest-catalog) for details.
+
+## Endpoint discovery and server-provided configuration
+
+On initialization, the client calls the server's configuration route
+(`GET /v1/config`, passing the configured `warehouse` as a query parameter if
+one is set). The response can adjust the client's configuration in three ways:
+
+- **`defaults`**: properties the server suggests; the client's own
+  configuration takes precedence over them.
+- **`overrides`**: properties the server requires; they take precedence over
+  the client's configuration. A common override is `prefix`, which the client
+  inserts into all subsequent request paths (`/v1/{prefix}/namespaces/...`)
+  so that one server can host multiple catalogs.
+- **`endpoints`**: the list of API endpoints the server supports. The client
+  only uses features whose endpoints are advertised, so a server that does not
+  implement, for example, view or scan-planning endpoints simply causes those
+  features to be unavailable rather than producing failed requests.
+
+If the server omits the `endpoints` field entirely, the client assumes a
+default set of namespace and table endpoints. For older servers that support
+views but predate endpoint discovery, set `view-endpoints-supported=true`
+(see [REST catalog properties](catalog-properties.md#rest-catalog-properties)).
+
+## Multi-table transactions
+
+The REST protocol can commit changes to multiple tables in one atomic
+operation (`POST /v1/{prefix}/transactions/commit`). Each participating table
+contributes its update requirements and metadata updates; the server validates
+all requirements and applies all updates atomically, so either every table
+commit succeeds or none does.
+
+In Java, this is exposed as `RESTCatalog.commitTransaction`:
+
+```java
+import org.apache.iceberg.catalog.TableCommit;
+
+// derive requirements and updates from each table's base and updated metadata
+TableCommit commit1 = TableCommit.create(identifier1, baseMetadata1, updatedMetadata1);
+TableCommit commit2 = TableCommit.create(identifier2, baseMetadata2, updatedMetadata2);
+
+catalog.commitTransaction(commit1, commit2);
+```
+
+This requires server support for the transactions endpoint.
+
+## Storage access delegation

Review Comment:
   I feel like a lot of the following are also pretty much user opaque features. A general user won't know these things are happening so I'm not sure how important it is for them to be in this doc. I think we should focus on things they need to know or would have to configure themselves. 
   
   Most of these (like storage access delegation) are not options the end user has any choice about.
   
   Most of those probably fit somewhere else in the docs as a technical reference but I think a lot of it is just transpositions from the spec



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For additional commands, e-mail: issues-help@iceberg.apache.org


Re: [PR] Docs: Add dedicated page for REST Catalog documentation [iceberg]

Posted by "talatuyarer (via GitHub)" <gi...@apache.org>.
talatuyarer commented on PR #17940:
URL: https://github.com/apache/iceberg/pull/17940#issuecomment-5534989181

   @RussellSpitzer I believe i adressed your comments. How it looks like now ? 


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For additional commands, e-mail: issues-help@iceberg.apache.org


Re: [PR] Docs: Add dedicated page for REST Catalog documentation [iceberg]

Posted by "RussellSpitzer (via GitHub)" <gi...@apache.org>.
RussellSpitzer commented on code in PR #17940:
URL: https://github.com/apache/iceberg/pull/17940#discussion_r3928311713


##########
docs/docs/rest-catalog.md:
##########
@@ -0,0 +1,228 @@
+---
+title: "REST Catalog"
+---
+<!--
+ - Licensed to the Apache Software Foundation (ASF) under one or more
+ - contributor license agreements.  See the NOTICE file distributed with
+ - this work for additional information regarding copyright ownership.
+ - The ASF licenses this file to You under the Apache License, Version 2.0
+ - (the "License"); you may not use this file except in compliance with
+ - the License.  You may obtain a copy of the License at
+ -
+ -   http://www.apache.org/licenses/LICENSE-2.0
+ -
+ - Unless required by applicable law or agreed to in writing, software
+ - distributed under the License is distributed on an "AS IS" BASIS,
+ - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ - See the License for the specific language governing permissions and
+ - limitations under the License.
+ -->
+
+# Iceberg REST Catalog
+
+The REST catalog is a client for any catalog service that implements the

Review Comment:
   An Iceberg REST Catalog is any catalog service that implements ...



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For additional commands, e-mail: issues-help@iceberg.apache.org


Re: [PR] Docs: Add dedicated page for REST Catalog documentation [iceberg]

Posted by "RussellSpitzer (via GitHub)" <gi...@apache.org>.
RussellSpitzer commented on code in PR #17940:
URL: https://github.com/apache/iceberg/pull/17940#discussion_r3928283183


##########
docs/mkdocs.yml:
##########
@@ -66,6 +66,7 @@ nav:
       - Delta Lake Migration: delta-lake-migration.md
   - Catalogs:
     - Catalog properties: catalog-properties.md
+    - rest-catalog.md

Review Comment:
   Something like 
   
   `Iceberg REST Compatible: rest-catalog`
   
   Instead



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For additional commands, e-mail: issues-help@iceberg.apache.org


Re: [PR] Docs: Add dedicated page for REST Catalog documentation [iceberg]

Posted by "talatuyarer (via GitHub)" <gi...@apache.org>.
talatuyarer commented on PR #17940:
URL: https://github.com/apache/iceberg/pull/17940#issuecomment-5544356343

   @kevinjqliu When you have a time Could you review this ? 


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For additional commands, e-mail: issues-help@iceberg.apache.org


Re: [PR] Docs: Add dedicated page for REST Catalog documentation [iceberg]

Posted by "talatuyarer (via GitHub)" <gi...@apache.org>.
talatuyarer commented on code in PR #17940:
URL: https://github.com/apache/iceberg/pull/17940#discussion_r3963481852


##########
docs/docs/rest-protocol.md:
##########
@@ -0,0 +1,180 @@
+---
+title: "REST Catalog Protocol"
+---
+<!--
+ - Licensed to the Apache Software Foundation (ASF) under one or more
+ - contributor license agreements.  See the NOTICE file distributed with
+ - this work for additional information regarding copyright ownership.
+ - The ASF licenses this file to You under the Apache License, Version 2.0
+ - (the "License"); you may not use this file except in compliance with
+ - the License.  You may obtain a copy of the License at
+ -
+ -   http://www.apache.org/licenses/LICENSE-2.0
+ -
+ - Unless required by applicable law or agreed to in writing, software
+ - distributed under the License is distributed on an "AS IS" BASIS,
+ - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ - See the License for the specific language governing permissions and
+ - limitations under the License.
+ -->
+
+# REST Catalog Protocol
+
+## Overview
+
+As the Iceberg ecosystem grew, every engine and language needed its own client
+for every catalog implementation. The REST catalog protocol solves this by
+putting the catalog logic behind a common HTTP API, defined by the
+[Iceberg REST Catalog API specification](../../rest-catalog-spec.md): a single
+client implementation works with any compliant server. Because the server owns
+commit logic, the protocol also enables capabilities that client-side catalogs
+cannot offer, such as server-side conflict resolution, multi-table commits,
+and secure table sharing through credential vending or remote signing.
+
+This page explains the concepts behind the protocol features and how the Java
+client uses them. For configuring a REST catalog connection and the full
+client property reference, see the [REST catalog page](rest-catalog.md).
+
+## Endpoint discovery and server-provided configuration
+
+On initialization, the client calls the server's configuration route
+(`GET /v1/config`, passing the configured `warehouse` as a query parameter if
+one is set). The response can adjust the client's configuration in three ways:
+
+- **`defaults`**: properties the server suggests; the client's own
+  configuration takes precedence over them.
+- **`overrides`**: properties the server requires; they take precedence over
+  the client's configuration. A common override is `prefix`, which the client
+  inserts into all subsequent request paths (`/v1/{prefix}/namespaces/...`)
+  so that one server can host multiple catalogs.
+- **`endpoints`**: the list of API endpoints the server supports. The client
+  only uses features whose endpoints are advertised, so a server that does not
+  implement, for example, view or scan-planning endpoints simply causes those
+  features to be unavailable rather than producing failed requests.
+
+If the server omits the `endpoints` field entirely, the client assumes a
+default set of namespace and table endpoints. For older servers that support
+views but predate endpoint discovery, set `view-endpoints-supported=true`
+(see [REST catalog properties](rest-catalog.md#configuration)).
+
+## Multi-table transactions

Review Comment:
   @kevinjqliu Fair point — I replaced the section with a 'Commit protocol' section describing the requirements/updates flow, and kept multi-table transactions as a short note there (optional endpoint, Java API only). PTAL



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For additional commands, e-mail: issues-help@iceberg.apache.org


Re: [PR] Docs: Add dedicated page for REST Catalog documentation [iceberg]

Posted by "kevinjqliu (via GitHub)" <gi...@apache.org>.
kevinjqliu commented on code in PR #17940:
URL: https://github.com/apache/iceberg/pull/17940#discussion_r3961153312


##########
docs/docs/rest-protocol.md:
##########
@@ -0,0 +1,180 @@
+---
+title: "REST Catalog Protocol"
+---
+<!--
+ - Licensed to the Apache Software Foundation (ASF) under one or more
+ - contributor license agreements.  See the NOTICE file distributed with
+ - this work for additional information regarding copyright ownership.
+ - The ASF licenses this file to You under the Apache License, Version 2.0
+ - (the "License"); you may not use this file except in compliance with
+ - the License.  You may obtain a copy of the License at
+ -
+ -   http://www.apache.org/licenses/LICENSE-2.0
+ -
+ - Unless required by applicable law or agreed to in writing, software
+ - distributed under the License is distributed on an "AS IS" BASIS,
+ - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ - See the License for the specific language governing permissions and
+ - limitations under the License.
+ -->
+
+# REST Catalog Protocol
+
+## Overview
+
+As the Iceberg ecosystem grew, every engine and language needed its own client
+for every catalog implementation. The REST catalog protocol solves this by
+putting the catalog logic behind a common HTTP API, defined by the
+[Iceberg REST Catalog API specification](../../rest-catalog-spec.md): a single
+client implementation works with any compliant server. Because the server owns
+commit logic, the protocol also enables capabilities that client-side catalogs
+cannot offer, such as server-side conflict resolution, multi-table commits,
+and secure table sharing through credential vending or remote signing.
+
+This page explains the concepts behind the protocol features and how the Java
+client uses them. For configuring a REST catalog connection and the full
+client property reference, see the [REST catalog page](rest-catalog.md).
+
+## Endpoint discovery and server-provided configuration
+
+On initialization, the client calls the server's configuration route
+(`GET /v1/config`, passing the configured `warehouse` as a query parameter if
+one is set). The response can adjust the client's configuration in three ways:
+
+- **`defaults`**: properties the server suggests; the client's own
+  configuration takes precedence over them.
+- **`overrides`**: properties the server requires; they take precedence over
+  the client's configuration. A common override is `prefix`, which the client
+  inserts into all subsequent request paths (`/v1/{prefix}/namespaces/...`)
+  so that one server can host multiple catalogs.
+- **`endpoints`**: the list of API endpoints the server supports. The client
+  only uses features whose endpoints are advertised, so a server that does not
+  implement, for example, view or scan-planning endpoints simply causes those
+  features to be unavailable rather than producing failed requests.
+
+If the server omits the `endpoints` field entirely, the client assumes a
+default set of namespace and table endpoints. For older servers that support
+views but predate endpoint discovery, set `view-endpoints-supported=true`
+(see [REST catalog properties](rest-catalog.md#configuration)).
+
+## Multi-table transactions

Review Comment:
   im a bit torn about this paragraph, i feel like this is over selling the capability. 
   Spark/Flink/Kafka Connect all use single-table transaction. 
   We technically can do this, but it requires both client implementation details and server implementation details. 
   
   What do you think about dropping "Multi-table transactions" and instead describing the commit protocol, i.e. the client sends requirements and updates and the server validates and applies them? That's the part of the protocol every user actually relies on, and the page doesn't cover it yet.



##########
docs/docs/rest-protocol.md:
##########
@@ -0,0 +1,180 @@
+---
+title: "REST Catalog Protocol"
+---
+<!--
+ - Licensed to the Apache Software Foundation (ASF) under one or more
+ - contributor license agreements.  See the NOTICE file distributed with
+ - this work for additional information regarding copyright ownership.
+ - The ASF licenses this file to You under the Apache License, Version 2.0
+ - (the "License"); you may not use this file except in compliance with
+ - the License.  You may obtain a copy of the License at
+ -
+ -   http://www.apache.org/licenses/LICENSE-2.0
+ -
+ - Unless required by applicable law or agreed to in writing, software
+ - distributed under the License is distributed on an "AS IS" BASIS,
+ - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ - See the License for the specific language governing permissions and
+ - limitations under the License.
+ -->
+
+# REST Catalog Protocol
+
+## Overview
+
+As the Iceberg ecosystem grew, every engine and language needed its own client
+for every catalog implementation. The REST catalog protocol solves this by
+putting the catalog logic behind a common HTTP API, defined by the
+[Iceberg REST Catalog API specification](../../rest-catalog-spec.md): a single
+client implementation works with any compliant server. Because the server owns
+commit logic, the protocol also enables capabilities that client-side catalogs
+cannot offer, such as server-side conflict resolution, multi-table commits,
+and secure table sharing through credential vending or remote signing.
+
+This page explains the concepts behind the protocol features and how the Java
+client uses them. For configuring a REST catalog connection and the full
+client property reference, see the [REST catalog page](rest-catalog.md).
+
+## Endpoint discovery and server-provided configuration
+
+On initialization, the client calls the server's configuration route
+(`GET /v1/config`, passing the configured `warehouse` as a query parameter if
+one is set). The response can adjust the client's configuration in three ways:
+
+- **`defaults`**: properties the server suggests; the client's own
+  configuration takes precedence over them.
+- **`overrides`**: properties the server requires; they take precedence over
+  the client's configuration. A common override is `prefix`, which the client
+  inserts into all subsequent request paths (`/v1/{prefix}/namespaces/...`)
+  so that one server can host multiple catalogs.
+- **`endpoints`**: the list of API endpoints the server supports. The client
+  only uses features whose endpoints are advertised, so a server that does not
+  implement, for example, view or scan-planning endpoints simply causes those
+  features to be unavailable rather than producing failed requests.
+
+If the server omits the `endpoints` field entirely, the client assumes a
+default set of namespace and table endpoints. For older servers that support
+views but predate endpoint discovery, set `view-endpoints-supported=true`
+(see [REST catalog properties](rest-catalog.md#configuration)).
+
+## Multi-table transactions
+
+The REST protocol can commit changes to multiple tables in one atomic
+operation (`POST /v1/{prefix}/transactions/commit`). Each participating table
+contributes its update requirements and metadata updates; the server validates
+all requirements and applies all updates atomically, so either every table
+commit succeeds or none does.
+
+In Java, this is exposed as `RESTCatalog.commitTransaction`:
+
+```java
+import org.apache.iceberg.catalog.TableCommit;
+
+// derive requirements and updates from each table's base and updated metadata
+TableCommit commit1 = TableCommit.create(identifier1, baseMetadata1, updatedMetadata1);
+TableCommit commit2 = TableCommit.create(identifier2, baseMetadata2, updatedMetadata2);
+
+catalog.commitTransaction(commit1, commit2);
+```
+
+Multi-table commits are optional on both sides: the server must support the
+transactions endpoint, and a server may restrict which operations can
+participate in a transaction. Engines generally do not expose multi-table
+commits through SQL today, so this is primarily a Java API feature.
+
+## Storage access delegation
+
+The REST protocol lets the catalog server control access to table data, so
+that clients do not need long-lived storage credentials of their own. The spec
+defines the `X-Iceberg-Access-Delegation` header with two mechanisms, and a
+server may supply access through either or both:
+
+### Credential vending
+
+The server returns short-lived, table-scoped storage credentials
+(`storage-credentials`) in the load-table response. The client applies them
+automatically when it creates the table's `FileIO`, so reads and writes of
+data and metadata files use the vended credentials without any client-side
+configuration. Because each credential is scoped to a table's storage
+prefixes, the catalog becomes the single point of access control.

Review Comment:
   ```suggestion
   The server returns short-lived, table-scoped storage credentials
   (`storage-credentials`) in the load-table response. When they are present, the
   client applies them when it creates the table's `FileIO`, so reads and writes
   of data and metadata files use the vended credentials. Because each credential
   is scoped to a table's storage prefixes, the catalog becomes the single point
   of access control.
   
   Whether credentials are vended is up to the server. Some servers only vend
   credentials when the request carries the `X-Iceberg-Access-Delegation` header.
   ```
   
   nit: adding some details about the header, and get rid of "without any client-side configuration" 



##########
docs/docs/rest-catalog.md:
##########
@@ -0,0 +1,172 @@
+---
+title: "REST Catalog"
+---
+<!--
+ - Licensed to the Apache Software Foundation (ASF) under one or more
+ - contributor license agreements.  See the NOTICE file distributed with
+ - this work for additional information regarding copyright ownership.
+ - The ASF licenses this file to You under the Apache License, Version 2.0
+ - (the "License"); you may not use this file except in compliance with
+ - the License.  You may obtain a copy of the License at
+ -
+ -   http://www.apache.org/licenses/LICENSE-2.0
+ -
+ - Unless required by applicable law or agreed to in writing, software
+ - distributed under the License is distributed on an "AS IS" BASIS,
+ - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ - See the License for the specific language governing permissions and
+ - limitations under the License.
+ -->
+
+# Iceberg REST Catalog
+
+An Iceberg REST catalog is any catalog service that implements the
+[Iceberg REST Catalog API specification](../../rest-catalog-spec.md). Instead of
+requiring a catalog-specific client in every engine and language, the catalog
+logic lives behind an HTTP API, and a single client implementation works with
+any compliant server.
+
+This page describes how to connect to a REST catalog from engines. For the protocol's features see the
+[REST Catalog Protocol](rest-protocol.md) concept page; for the protocol
+definition itself, see the [spec page](../../rest-catalog-spec.md). To try the
+protocol locally, the community publishes the
+[`apache/iceberg-rest-fixture`](https://hub.docker.com/r/apache/iceberg-rest-fixture)
+Docker image, which serves the REST API backed by an in-memory catalog; see its
+[README](https://github.com/apache/iceberg/blob/main/docker/iceberg-rest-fixture/README.md)
+for how to run and configure it, or the
+[Spark quickstart](../../spark-quickstart.md).
+
+## Examples
+
+### Spark
+
+```shell
+spark-sql --packages org.apache.iceberg:iceberg-spark-runtime-{{ sparkVersionMajor }}:{{ icebergVersion }} \
+    --conf spark.sql.catalog.my_catalog=org.apache.iceberg.spark.SparkCatalog \
+    --conf spark.sql.catalog.my_catalog.type=rest \
+    --conf spark.sql.catalog.my_catalog.uri=https://catalog-service/api/catalog \
+    --conf spark.sql.catalog.my_catalog.warehouse=my_warehouse \
+    --conf spark.sql.catalog.my_catalog.rest.auth.type=oauth2 \
+    --conf spark.sql.catalog.my_catalog.credential=<client_id>:<client_secret>
+```
+
+See [Spark catalog configuration](spark-configuration.md#catalog-configuration)
+for details.
+
+### Flink
+
+```sql
+CREATE CATALOG prod WITH (
+  'type'='iceberg',
+  'catalog-type'='rest',
+  'uri'='https://catalog-service/api/catalog'
+);
+```
+
+See the [Flink catalog documentation](flink.md#rest-catalog) for details.
+
+## Configuration
+
+Connecting to a REST catalog requires at minimum a `uri` pointing at the
+service. The following properties configure the client side of the
+connection; the
+[common catalog properties](catalog-properties.md) (such as `warehouse` and
+`io-impl`) apply as well. Note that the server can adjust this configuration
+at connection time through
+[endpoint discovery](rest-protocol.md#endpoint-discovery-and-server-provided-configuration).
+
+| Property                              | Default           | Description                                                                                                                                                                                      |
+|---------------------------------------|-------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `snapshot-loading-mode`               | `ALL`             | Controls how snapshots are loaded from the REST server. Supported values: `ALL` (load all snapshots), `REFS` (load only referenced snapshots).                                                  |
+| `rest-metrics-reporting-enabled`      | `true`            | Whether to enable metrics reporting to the REST server.                                                                                                                                          |
+| `view-endpoints-supported`            | `false`           | For backwards compatibility with older REST servers. Set to `true` if the server supports view endpoints but doesn't send the `endpoints` field in the ConfigResponse.                          |
+| `rest-page-size`                      | null              | The page size to use when listing namespaces, tables, or other paginated resources.                                                                                                              |
+| `namespace-separator`                 | `%1F`             | The separator character used for namespace levels when communicating with the REST server.                                                                                                       |
+| `scan-planning-mode`                  | `CLIENT`          | Controls where scan planning is performed. Supported values: `CLIENT` (client-side planning), `SERVER` (server-side planning). Can be overridden per-table by the server in LoadTableResponse. |

Review Comment:
   ```suggestion
   | `scan-planning-mode`                  | `client`          | Controls where scan planning is performed. Supported values: `client` (client-side planning), `server` (server-side planning). Can be overridden per-table by the server in LoadTableResponse. |
   ```
   
   nit these should be lower cased 



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For additional commands, e-mail: issues-help@iceberg.apache.org


Re: [PR] Docs: Add dedicated page for REST Catalog documentation [iceberg]

Posted by "talatuyarer (via GitHub)" <gi...@apache.org>.
talatuyarer commented on code in PR #17940:
URL: https://github.com/apache/iceberg/pull/17940#discussion_r3936749038


##########
docs/docs/rest-catalog.md:
##########
@@ -0,0 +1,166 @@
+---
+title: "REST Catalog"
+---
+<!--
+ - Licensed to the Apache Software Foundation (ASF) under one or more
+ - contributor license agreements.  See the NOTICE file distributed with
+ - this work for additional information regarding copyright ownership.
+ - The ASF licenses this file to You under the Apache License, Version 2.0
+ - (the "License"); you may not use this file except in compliance with
+ - the License.  You may obtain a copy of the License at
+ -
+ -   http://www.apache.org/licenses/LICENSE-2.0
+ -
+ - Unless required by applicable law or agreed to in writing, software
+ - distributed under the License is distributed on an "AS IS" BASIS,
+ - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ - See the License for the specific language governing permissions and
+ - limitations under the License.
+ -->
+
+# Iceberg REST Catalog
+
+An Iceberg REST catalog is any catalog service that implements the
+[Iceberg REST Catalog API specification](../../rest-catalog-spec.md). Instead of
+requiring a catalog-specific client in every engine and language, the catalog
+logic lives behind an HTTP API, and a single client implementation works with
+any compliant server.
+
+This page describes how to connect to a REST catalog from engines. For the protocol's features see the
+[REST Catalog Protocol](rest-protocol.md) concept page; for the protocol
+definition itself, see the [spec page](../../rest-catalog-spec.md). To try the
+protocol locally, the community publishes the
+[`apache/iceberg-rest-fixture`](https://hub.docker.com/r/apache/iceberg-rest-fixture)
+Docker image, which serves the REST API backed by an in-memory catalog; see its
+[README](https://github.com/apache/iceberg/blob/main/docker/iceberg-rest-fixture/README.md)
+for how to run and configure it, or the
+[Spark quickstart](../../spark-quickstart.md).
+
+## Configuration
+
+Connecting to a REST catalog requires at minimum a `uri` pointing at the
+service. The following properties configure the client side of the
+connection; the
+[common catalog properties](catalog-properties.md) (such as `warehouse` and
+`io-impl`) apply as well. Note that the server can adjust this configuration
+at connection time through
+[endpoint discovery](rest-protocol.md#endpoint-discovery-and-server-provided-configuration).
+
+| Property                              | Default           | Description                                                                                                                                                                                      |
+|---------------------------------------|-------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `snapshot-loading-mode`               | `ALL`             | Controls how snapshots are loaded from the REST server. Supported values: `ALL` (load all snapshots), `REFS` (load only referenced snapshots).                                                  |
+| `rest-metrics-reporting-enabled`      | `true`            | Whether to enable metrics reporting to the REST server.                                                                                                                                          |
+| `view-endpoints-supported`            | `false`           | For backwards compatibility with older REST servers. Set to `true` if the server supports view endpoints but doesn't send the `endpoints` field in the ConfigResponse.                          |
+| `rest-page-size`                      | null              | The page size to use when listing namespaces, tables, or other paginated resources.                                                                                                              |
+| `namespace-separator`                 | `%1F`             | The separator character used for namespace levels when communicating with the REST server.                                                                                                       |
+| `scan-planning-mode`                  | `CLIENT`          | Controls where scan planning is performed. Supported values: `CLIENT` (client-side planning), `SERVER` (server-side planning). Can be overridden per-table by the server in LoadTableResponse. |
+| `rest.client.max-retries`           | `5`     | Maximum number of times to retry a failed HTTP request, using exponential backoff between attempts.                                                                                                                                                                                                                 |
+| `rest.client.max-connections`       | `100`   | Maximum total number of connections in the HTTP client connection pool. A JVM system property with the same name takes precedence over this catalog property.                                                                                                                                                       |
+| `rest.client.connections-per-route` | `100`   | Maximum number of pooled connections per route.                                                                                                                                                                                                                                                                     |
+| `rest.client.connection-timeout-ms` | null    | Timeout in milliseconds for establishing a connection to the server. If not set, the HTTP client library default is used.                                                                                                                                                                                           |
+| `rest.client.socket-timeout-ms`     | null    | Socket timeout in milliseconds for awaiting data on a connection. If not set, the HTTP client library default is used.                                                                                                                                                                                              |
+| `rest.client.user-agent`            | null    | Custom `User-Agent` header value to send with each request. If not set, the HTTP client library default is used.                                                                                                                                                                                                    |
+| `rest.client.proxy.hostname`        | null    | Hostname of an HTTP proxy to route requests through. Must be set together with `rest.client.proxy.port` to take effect.                                                                                                                                                                                             |
+| `rest.client.proxy.port`            | null    | Port of the HTTP proxy. Must be set together with `rest.client.proxy.hostname` to take effect.                                                                                                                                                                                                                      |
+| `rest.client.proxy.username`        | null    | Username for proxy authentication. Must be set together with `rest.client.proxy.password` to take effect, and only applies when the proxy hostname and port are configured. Only Basic authentication is supported.                                                                                                 |
+| `rest.client.proxy.password`        | null    | Password for proxy authentication. Must be set together with `rest.client.proxy.username` to take effect.                                                                                                                                                                                                           |
+| `rest.client.tls.configurer-impl`   | null    | A custom `org.apache.iceberg.rest.auth.TLSConfigurer` implementation to customize TLS settings such as the `SSLContext`, hostname verifier, supported protocols, and cipher suites. The implementation must have a no-arg constructor and is initialized with the catalog properties. If it returns a non-null hostname verifier, that verifier replaces the built-in JSSE hostname verification. |
+
+### Table cache properties
+
+The following properties configure the table cache used for freshness-aware table loading. Note, this cache is different from the one that can be configured at catalog level in general.
+
+| Property                                 | Default           | Description                                                                            |
+|-------------------------------------------|-------------------|------------------------------------------------------------------------------------------|
+| `rest-table-cache.expire-after-write-ms` | `300000` (5 min)  | Time in milliseconds after which cached table entries expire.                          |
+| `rest-table-cache.max-entries`           | `100`             | Maximum number of table entries to cache.                                              |
+
+## Authentication
+
+Most deployments require authentication, which is specific to the catalog
+service. The following catalog properties configure the potential
+authentication mechanisms: Basic, OAuth2, SigV4, and Google.
+
+### REST auth properties
+
+| Property                             | Default          | Description                                                                                                       |
+|--------------------------------------|------------------|-------------------------------------------------------------------------------------------------------------------|
+| `rest.auth.type`                     | `none`           | Authentication mechanism for REST catalog access. Supported values: `none`, `basic`, `oauth2`, `sigv4`, `google`. |
+| `rest.auth.basic.username`           | null             | Username for Basic authentication. Required if `rest.auth.type` = `basic`.                                        |
+| `rest.auth.basic.password`           | null             | Password for Basic authentication. Required if `rest.auth.type` = `basic`.                                        |
+| `rest.auth.sigv4.delegate-auth-type` | `oauth2`         | Auth type to delegate to after `sigv4` signing.                                                                   |
+
+### OAuth2 auth properties
+Required and optional properties to include while using `oauth2` authentication
+
+| Property                | Default           | Description                                                                                                                                                           |
+|-------------------------|-------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `token`                 | null              | A Bearer token to interact with the server. Either `token` or `credential` is required.                                                                               |
+| `credential`            | null              | Credential string in the form of `client_id:client_secret` to exchange for a token in the OAuth2 client credentials flow. Either `token` or `credential` is required. |
+| `oauth2-server-uri`     | `v1/oauth/tokens` | OAuth2 token endpoint URI. Required if the REST catalog is not the OAuth2 authentication server.                                                                      |
+| `token-expires-in-ms`   | 3600000 (1 hour)  | Time in milliseconds after which a bearer token is considered expired. Used to decide when to refresh or re-exchange a token.                                         |
+| `token-refresh-enabled` | true              | Determines whether tokens are automatically refreshed when expiration details are available.                                                                          |
+| `token-exchange-enabled`| true              | Determines whether to use the token exchange flow to acquire new tokens. Disabling this will allow fallback to the client credential flow.                            |
+| `scope`                 | `catalog`         | Additional scope for `oauth2`.                                                                                                                                        |
+| `audience`              | null              | Optional param to specify token `audience`                                                                                                                            |
+| `resource`              | null              | Optional param to specify `resource`                                                                                                                                  |
+
+### SigV4 auth properties
+Required and optional properties to include while using `sigv4` authentication
+
+| Property                             | Default          | Description                                                                                                       |
+|--------------------------------------|------------------|-------------------------------------------------------------------------------------------------------------------|
+| `rest.signing-region`                     | null           | Region to be used by the SigV4 protocol for signing requests. |
+| `rest.signing-name`                       | `execute-api`  | The service name to be used by the SigV4 protocol for signing requests. |
+| `rest.access-key-id`                      | null           | Configure the static access key ID used for SigV4 signing. |
+| `rest.secret-access-key`                  | null           | Configure the static secret access key used for SigV4 signing. |
+| `rest.session-token`                      | null           | Configure the static session token used for SigV4. |
+| `client.credentials-provider`             | null           | When configured, REST catalog requests will use this provider to get AWS credentials to sign the request instead of reading the default credential chain. |
+| `client.assume-role.arn`            | null, requires user input                | ARN of the role to assume, e.g. arn:aws:iam::123456789:role/myRoleToAssume  |
+| `client.assume-role.region`         | null, requires user input                | All AWS clients except the STS client will use the given region instead of the default region chain  |
+| `client.assume-role.external-id`    | null                                     | An optional [external ID](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html)  |
+| `client.assume-role.timeout-sec`    | 1 hour                                   | Timeout of each assume role session. At the end of the timeout, a new set of role session credentials will be fetched through an STS client.  |
+
+When `rest.access-key-id`, `rest.secret-access-key`, and optionally `rest.session-token` are configured, REST Catalog requests will be signed with the provided basic or session credentials instead of using the default credential chain. If `rest.session-token` is set, session credential is used, otherwise basic credential is used.
+
+When basic or session credentials are provided, the provided credentials will be used instead of `client.credentials-provider`. `client.credentials-provider` must contain a static `create` or `create(Map<String, String>)` method to be used by REST catalog requests.
+
+When `client.assume-role.arn` and `client.assume-role.region` are configured, Iceberg will assume the role using the default credential chain to sign REST catalog requests. These parameters will have no effect if `rest.access-key-id`, `rest.secret-access-key`, or `client.credentials-provider` are configured.
+
+### Google auth properties
+Required and optional properties to include while using `google` authentication
+
+| Property                   | Default                                          | Description                                      |
+|----------------------------|--------------------------------------------------|--------------------------------------------------|
+| `gcp.auth.credentials-path`| Application Default Credentials (ADC)            | Path to a service account JSON key file.         |
+| `gcp.auth.credentials-json` | Application Default Credentials (ADC)            | JSON string of a service account credential.     |
+| `gcp.auth.scopes`          | `https://www.googleapis.com/auth/cloud-platform` | Comma-separated list of OAuth scopes to request. |
+
+## Examples

Review Comment:
   Sounds good! Moved to top of configuration section 



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For additional commands, e-mail: issues-help@iceberg.apache.org


Re: [PR] Docs: Add dedicated page for REST Catalog documentation [iceberg]

Posted by "RussellSpitzer (via GitHub)" <gi...@apache.org>.
RussellSpitzer commented on code in PR #17940:
URL: https://github.com/apache/iceberg/pull/17940#discussion_r3928343175


##########
docs/docs/rest-catalog.md:
##########
@@ -0,0 +1,228 @@
+---
+title: "REST Catalog"
+---
+<!--
+ - Licensed to the Apache Software Foundation (ASF) under one or more
+ - contributor license agreements.  See the NOTICE file distributed with
+ - this work for additional information regarding copyright ownership.
+ - The ASF licenses this file to You under the Apache License, Version 2.0
+ - (the "License"); you may not use this file except in compliance with
+ - the License.  You may obtain a copy of the License at
+ -
+ -   http://www.apache.org/licenses/LICENSE-2.0
+ -
+ - Unless required by applicable law or agreed to in writing, software
+ - distributed under the License is distributed on an "AS IS" BASIS,
+ - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ - See the License for the specific language governing permissions and
+ - limitations under the License.
+ -->
+
+# Iceberg REST Catalog
+
+The REST catalog is a client for any catalog service that implements the
+[Iceberg REST Catalog API specification](../../rest-catalog-spec.md). Instead of
+requiring a catalog-specific client in every engine and language, the catalog
+logic lives behind an HTTP API, and a single client implementation works with
+any compliant server.
+
+This page describes how to configure the REST catalog client and the protocol
+features it supports. For the protocol definition itself, see the
+[spec page](../../rest-catalog-spec.md). To try the protocol locally, the
+community publishes the
+[`apache/iceberg-rest-fixture`](https://hub.docker.com/r/apache/iceberg-rest-fixture)
+Docker image, which serves the REST API backed by an in-memory catalog; see its
+[README](https://github.com/apache/iceberg/blob/main/docker/iceberg-rest-fixture/README.md)
+for how to run and configure it, or the
+[Spark quickstart](../../spark-quickstart.md).
+
+## Configuring a REST catalog
+
+A REST catalog needs at minimum a `uri` pointing at the server. Most
+deployments also configure authentication; see
+[REST auth properties](catalog-properties.md#auth-properties) for the
+supported mechanisms (Basic, OAuth2, SigV4, and Google). The full list of
+client properties is in
+[REST catalog properties](catalog-properties.md#rest-catalog-properties).
+
+### Java
+
+```java
+import java.util.HashMap;
+import java.util.Map;
+import org.apache.iceberg.CatalogProperties;
+import org.apache.iceberg.rest.RESTCatalog;
+
+Map<String, String> properties = new HashMap<>();
+properties.put(CatalogProperties.URI, "https://catalog-service/api/catalog");
+
+RESTCatalog catalog = new RESTCatalog();
+catalog.initialize("prod", properties);
+```
+
+Engines that load catalogs through `CatalogUtil.buildIcebergCatalog` select the
+REST catalog with `type=rest`.
+
+### Spark
+
+```ini
+spark.sql.catalog.prod          = org.apache.iceberg.spark.SparkCatalog
+spark.sql.catalog.prod.type     = rest
+spark.sql.catalog.prod.uri      = https://catalog-service/api/catalog
+```
+
+See [Spark catalog configuration](spark-configuration.md#catalog-configuration)
+for details.
+
+### Flink
+
+```sql
+CREATE CATALOG prod WITH (
+  'type'='iceberg',
+  'catalog-type'='rest',
+  'uri'='https://catalog-service/api/catalog'
+);
+```
+
+See the [Flink catalog documentation](flink.md#rest-catalog) for details.
+
+## Endpoint discovery and server-provided configuration

Review Comment:
   I am not sure this is really required for user facing documentation. It's pretty low level and the user won't really be able to change anything about this anyway. 



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For additional commands, e-mail: issues-help@iceberg.apache.org


Re: [PR] Docs: Add dedicated page for REST Catalog documentation [iceberg]

Posted by "RussellSpitzer (via GitHub)" <gi...@apache.org>.
RussellSpitzer commented on code in PR #17940:
URL: https://github.com/apache/iceberg/pull/17940#discussion_r3928322643


##########
docs/docs/rest-catalog.md:
##########
@@ -0,0 +1,228 @@
+---
+title: "REST Catalog"
+---
+<!--
+ - Licensed to the Apache Software Foundation (ASF) under one or more
+ - contributor license agreements.  See the NOTICE file distributed with
+ - this work for additional information regarding copyright ownership.
+ - The ASF licenses this file to You under the Apache License, Version 2.0
+ - (the "License"); you may not use this file except in compliance with
+ - the License.  You may obtain a copy of the License at
+ -
+ -   http://www.apache.org/licenses/LICENSE-2.0
+ -
+ - Unless required by applicable law or agreed to in writing, software
+ - distributed under the License is distributed on an "AS IS" BASIS,
+ - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ - See the License for the specific language governing permissions and
+ - limitations under the License.
+ -->
+
+# Iceberg REST Catalog
+
+The REST catalog is a client for any catalog service that implements the
+[Iceberg REST Catalog API specification](../../rest-catalog-spec.md). Instead of
+requiring a catalog-specific client in every engine and language, the catalog
+logic lives behind an HTTP API, and a single client implementation works with
+any compliant server.
+
+This page describes how to configure the REST catalog client and the protocol
+features it supports. For the protocol definition itself, see the
+[spec page](../../rest-catalog-spec.md). To try the protocol locally, the
+community publishes the
+[`apache/iceberg-rest-fixture`](https://hub.docker.com/r/apache/iceberg-rest-fixture)
+Docker image, which serves the REST API backed by an in-memory catalog; see its
+[README](https://github.com/apache/iceberg/blob/main/docker/iceberg-rest-fixture/README.md)
+for how to run and configure it, or the
+[Spark quickstart](../../spark-quickstart.md).
+
+## Configuring a REST catalog
+
+A REST catalog needs at minimum a `uri` pointing at the server. Most
+deployments also configure authentication; see

Review Comment:
   Most deployments also require authentication which is specific to that service; 



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For additional commands, e-mail: issues-help@iceberg.apache.org


Re: [PR] Docs: Add dedicated page for REST Catalog documentation [iceberg]

Posted by "kevinjqliu (via GitHub)" <gi...@apache.org>.
kevinjqliu commented on PR #17940:
URL: https://github.com/apache/iceberg/pull/17940#issuecomment-5588888036

   taking a look! 


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For additional commands, e-mail: issues-help@iceberg.apache.org


Re: [PR] Docs: Add dedicated page for REST Catalog documentation [iceberg]

Posted by "RussellSpitzer (via GitHub)" <gi...@apache.org>.
RussellSpitzer commented on code in PR #17940:
URL: https://github.com/apache/iceberg/pull/17940#discussion_r3928355298


##########
docs/docs/rest-catalog.md:
##########
@@ -0,0 +1,228 @@
+---
+title: "REST Catalog"
+---
+<!--
+ - Licensed to the Apache Software Foundation (ASF) under one or more
+ - contributor license agreements.  See the NOTICE file distributed with
+ - this work for additional information regarding copyright ownership.
+ - The ASF licenses this file to You under the Apache License, Version 2.0
+ - (the "License"); you may not use this file except in compliance with
+ - the License.  You may obtain a copy of the License at
+ -
+ -   http://www.apache.org/licenses/LICENSE-2.0
+ -
+ - Unless required by applicable law or agreed to in writing, software
+ - distributed under the License is distributed on an "AS IS" BASIS,
+ - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ - See the License for the specific language governing permissions and
+ - limitations under the License.
+ -->
+
+# Iceberg REST Catalog
+
+The REST catalog is a client for any catalog service that implements the
+[Iceberg REST Catalog API specification](../../rest-catalog-spec.md). Instead of
+requiring a catalog-specific client in every engine and language, the catalog
+logic lives behind an HTTP API, and a single client implementation works with
+any compliant server.
+
+This page describes how to configure the REST catalog client and the protocol
+features it supports. For the protocol definition itself, see the
+[spec page](../../rest-catalog-spec.md). To try the protocol locally, the
+community publishes the
+[`apache/iceberg-rest-fixture`](https://hub.docker.com/r/apache/iceberg-rest-fixture)
+Docker image, which serves the REST API backed by an in-memory catalog; see its
+[README](https://github.com/apache/iceberg/blob/main/docker/iceberg-rest-fixture/README.md)
+for how to run and configure it, or the
+[Spark quickstart](../../spark-quickstart.md).
+
+## Configuring a REST catalog
+
+A REST catalog needs at minimum a `uri` pointing at the server. Most
+deployments also configure authentication; see
+[REST auth properties](catalog-properties.md#auth-properties) for the
+supported mechanisms (Basic, OAuth2, SigV4, and Google). The full list of
+client properties is in
+[REST catalog properties](catalog-properties.md#rest-catalog-properties).
+
+### Java
+
+```java
+import java.util.HashMap;
+import java.util.Map;
+import org.apache.iceberg.CatalogProperties;
+import org.apache.iceberg.rest.RESTCatalog;
+
+Map<String, String> properties = new HashMap<>();
+properties.put(CatalogProperties.URI, "https://catalog-service/api/catalog");
+
+RESTCatalog catalog = new RESTCatalog();
+catalog.initialize("prod", properties);
+```
+
+Engines that load catalogs through `CatalogUtil.buildIcebergCatalog` select the
+REST catalog with `type=rest`.
+
+### Spark
+
+```ini
+spark.sql.catalog.prod          = org.apache.iceberg.spark.SparkCatalog
+spark.sql.catalog.prod.type     = rest
+spark.sql.catalog.prod.uri      = https://catalog-service/api/catalog
+```
+
+See [Spark catalog configuration](spark-configuration.md#catalog-configuration)
+for details.
+
+### Flink
+
+```sql
+CREATE CATALOG prod WITH (
+  'type'='iceberg',
+  'catalog-type'='rest',
+  'uri'='https://catalog-service/api/catalog'
+);
+```
+
+See the [Flink catalog documentation](flink.md#rest-catalog) for details.
+
+## Endpoint discovery and server-provided configuration
+
+On initialization, the client calls the server's configuration route
+(`GET /v1/config`, passing the configured `warehouse` as a query parameter if
+one is set). The response can adjust the client's configuration in three ways:
+
+- **`defaults`**: properties the server suggests; the client's own
+  configuration takes precedence over them.
+- **`overrides`**: properties the server requires; they take precedence over
+  the client's configuration. A common override is `prefix`, which the client
+  inserts into all subsequent request paths (`/v1/{prefix}/namespaces/...`)
+  so that one server can host multiple catalogs.
+- **`endpoints`**: the list of API endpoints the server supports. The client
+  only uses features whose endpoints are advertised, so a server that does not
+  implement, for example, view or scan-planning endpoints simply causes those
+  features to be unavailable rather than producing failed requests.
+
+If the server omits the `endpoints` field entirely, the client assumes a
+default set of namespace and table endpoints. For older servers that support
+views but predate endpoint discovery, set `view-endpoints-supported=true`
+(see [REST catalog properties](catalog-properties.md#rest-catalog-properties)).
+
+## Multi-table transactions

Review Comment:
   May want to notice this is optionally supported by a Catalog and engine. Just because at the moment you can't really do this through Spark and at least Polaris doesn't support this except for appends. Other catalogs might though but  :shrug: 



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For additional commands, e-mail: issues-help@iceberg.apache.org


Re: [PR] Docs: Add dedicated page for REST Catalog documentation [iceberg]

Posted by "RussellSpitzer (via GitHub)" <gi...@apache.org>.
RussellSpitzer commented on code in PR #17940:
URL: https://github.com/apache/iceberg/pull/17940#discussion_r3928332476


##########
docs/docs/rest-catalog.md:
##########
@@ -0,0 +1,228 @@
+---
+title: "REST Catalog"
+---
+<!--
+ - Licensed to the Apache Software Foundation (ASF) under one or more
+ - contributor license agreements.  See the NOTICE file distributed with
+ - this work for additional information regarding copyright ownership.
+ - The ASF licenses this file to You under the Apache License, Version 2.0
+ - (the "License"); you may not use this file except in compliance with
+ - the License.  You may obtain a copy of the License at
+ -
+ -   http://www.apache.org/licenses/LICENSE-2.0
+ -
+ - Unless required by applicable law or agreed to in writing, software
+ - distributed under the License is distributed on an "AS IS" BASIS,
+ - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ - See the License for the specific language governing permissions and
+ - limitations under the License.
+ -->
+
+# Iceberg REST Catalog
+
+The REST catalog is a client for any catalog service that implements the
+[Iceberg REST Catalog API specification](../../rest-catalog-spec.md). Instead of
+requiring a catalog-specific client in every engine and language, the catalog
+logic lives behind an HTTP API, and a single client implementation works with
+any compliant server.
+
+This page describes how to configure the REST catalog client and the protocol
+features it supports. For the protocol definition itself, see the
+[spec page](../../rest-catalog-spec.md). To try the protocol locally, the
+community publishes the
+[`apache/iceberg-rest-fixture`](https://hub.docker.com/r/apache/iceberg-rest-fixture)
+Docker image, which serves the REST API backed by an in-memory catalog; see its
+[README](https://github.com/apache/iceberg/blob/main/docker/iceberg-rest-fixture/README.md)
+for how to run and configure it, or the
+[Spark quickstart](../../spark-quickstart.md).
+
+## Configuring a REST catalog
+
+A REST catalog needs at minimum a `uri` pointing at the server. Most
+deployments also configure authentication; see
+[REST auth properties](catalog-properties.md#auth-properties) for the
+supported mechanisms (Basic, OAuth2, SigV4, and Google). The full list of
+client properties is in
+[REST catalog properties](catalog-properties.md#rest-catalog-properties).
+
+### Java
+
+```java
+import java.util.HashMap;
+import java.util.Map;
+import org.apache.iceberg.CatalogProperties;
+import org.apache.iceberg.rest.RESTCatalog;
+
+Map<String, String> properties = new HashMap<>();
+properties.put(CatalogProperties.URI, "https://catalog-service/api/catalog");
+
+RESTCatalog catalog = new RESTCatalog();
+catalog.initialize("prod", properties);
+```
+
+Engines that load catalogs through `CatalogUtil.buildIcebergCatalog` select the

Review Comment:
   This is probably not very helpful as I imagine very few users know what this means. I'd Just Skip to the spark example



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For additional commands, e-mail: issues-help@iceberg.apache.org


Re: [PR] Docs: Add dedicated page for REST Catalog documentation [iceberg]

Posted by "RussellSpitzer (via GitHub)" <gi...@apache.org>.
RussellSpitzer commented on code in PR #17940:
URL: https://github.com/apache/iceberg/pull/17940#discussion_r3928324987


##########
docs/docs/rest-catalog.md:
##########
@@ -0,0 +1,228 @@
+---
+title: "REST Catalog"
+---
+<!--
+ - Licensed to the Apache Software Foundation (ASF) under one or more
+ - contributor license agreements.  See the NOTICE file distributed with
+ - this work for additional information regarding copyright ownership.
+ - The ASF licenses this file to You under the Apache License, Version 2.0
+ - (the "License"); you may not use this file except in compliance with
+ - the License.  You may obtain a copy of the License at
+ -
+ -   http://www.apache.org/licenses/LICENSE-2.0
+ -
+ - Unless required by applicable law or agreed to in writing, software
+ - distributed under the License is distributed on an "AS IS" BASIS,
+ - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ - See the License for the specific language governing permissions and
+ - limitations under the License.
+ -->
+
+# Iceberg REST Catalog
+
+The REST catalog is a client for any catalog service that implements the
+[Iceberg REST Catalog API specification](../../rest-catalog-spec.md). Instead of
+requiring a catalog-specific client in every engine and language, the catalog
+logic lives behind an HTTP API, and a single client implementation works with
+any compliant server.
+
+This page describes how to configure the REST catalog client and the protocol
+features it supports. For the protocol definition itself, see the
+[spec page](../../rest-catalog-spec.md). To try the protocol locally, the
+community publishes the
+[`apache/iceberg-rest-fixture`](https://hub.docker.com/r/apache/iceberg-rest-fixture)
+Docker image, which serves the REST API backed by an in-memory catalog; see its
+[README](https://github.com/apache/iceberg/blob/main/docker/iceberg-rest-fixture/README.md)
+for how to run and configure it, or the
+[Spark quickstart](../../spark-quickstart.md).
+
+## Configuring a REST catalog
+
+A REST catalog needs at minimum a `uri` pointing at the server. Most
+deployments also configure authentication; see
+[REST auth properties](catalog-properties.md#auth-properties) for the
+supported mechanisms (Basic, OAuth2, SigV4, and Google). The full list of

Review Comment:
   potential mechanisms 



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For additional commands, e-mail: issues-help@iceberg.apache.org


Re: [PR] Docs: Add dedicated page for REST Catalog documentation [iceberg]

Posted by "kevinjqliu (via GitHub)" <gi...@apache.org>.
kevinjqliu merged PR #17940:
URL: https://github.com/apache/iceberg/pull/17940


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For additional commands, e-mail: issues-help@iceberg.apache.org


Re: [PR] Docs: Add dedicated page for REST Catalog documentation [iceberg]

Posted by "uros-b (via GitHub)" <gi...@apache.org>.
uros-b commented on PR #17940:
URL: https://github.com/apache/iceberg/pull/17940#issuecomment-5551534777

   Seems like there are some conflicts here, but otherwise looks good! Thank you @talatuyarer and @RussellSpitzer!


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For additional commands, e-mail: issues-help@iceberg.apache.org


Re: [PR] Docs: Add dedicated page for REST Catalog documentation [iceberg]

Posted by "kevinjqliu (via GitHub)" <gi...@apache.org>.
kevinjqliu commented on PR #17940:
URL: https://github.com/apache/iceberg/pull/17940#issuecomment-5590238066

   Thanks for working on this! This is overall better than the previous docs ❤️ and I rendered locally to double check the formatting. 
   
   I have a nit on the "Multi-table transactions" part, otherwise everything looks great! 


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For additional commands, e-mail: issues-help@iceberg.apache.org