You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
<!--
Thanks for opening a pull request!
-->
<!-- In the case this PR will resolve an issue, please replace
${GITHUB_ISSUE_ID} below with the actual Github issue id. -->
<!-- Closes #${GITHUB_ISSUE_ID} -->
# Rationale for this change
Closes#2096
Included examples and detailed configuration guidance to enhance
clarity.
# Are these changes tested?
# Are there any user-facing changes?
<!-- In the case of user-facing changes, please add the changelog label.
-->
---------
Co-authored-by: Kevin Liu <[email protected]>
Co-authored-by: Kevin Liu <[email protected]>
| uri | <https://rest-catalog/ws> | URI identifying the REST Server |
343
-
| ugi | t-1234:secret | Hadoop UGI for Hive client. |
344
-
| credential | t-1234:secret | Credential to use for OAuth2 credential flow when initializing the catalog |
345
-
| token | FEW23.DFSDF.FSDF | Bearer token value to use for `Authorization` header |
342
+
| uri | <https://rest-catalog/ws> | URI identifying the REST Server |
343
+
| warehouse | myWarehouse | Warehouse location or identifier to request from the catalog service. May be used to determine server-side overrides, such as the warehouse location. |
344
+
| snapshot-loading-mode | refs | The snapshots to return in the body of the metadata. Setting the value to `all` would return the full set of snapshots currently valid for the table. Setting the value to `refs` would load all snapshots referenced by branches or tags. |
345
+
| `header.X-Iceberg-Access-Delegation` | `vended-credentials` | Signal to the server that the client supports delegated access via a comma-separated list of access mechanisms. The server may choose to supply access via any or none of the requested mechanisms. When using `vended-credentials`, the server provides temporary credentials to the client. When using `remote-signing`, the server signs requests on behalf of the client. (default: `vended-credentials`) |
346
+
347
+
#### Headers in REST Catalog
348
+
349
+
To configure custom headers in REST Catalog, include them in the catalog properties with `header.<Header-Name>`. This
350
+
ensures that all HTTP requests to the REST service include the specified headers.
| rest.sigv4-enabled | true | Sign requests to the REST Server using AWS SigV4 protocol |
350
378
| rest.signing-region | us-east-1 | The region to use when SigV4 signing a request |
351
379
| rest.signing-name | execute-api | The service signing name to use when SigV4 signing a request |
352
-
| oauth2-server-uri | <https://auth-service/cc> | Authentication URL to use for client credentials authentication (default: uri + 'v1/oauth/tokens') |
353
-
| snapshot-loading-mode | refs | The snapshots to return in the body of the metadata. Setting the value to `all` would return the full set of snapshots currently valid for the table. Setting the value to `refs` would load all snapshots referenced by branches or tags. |
354
-
| warehouse | myWarehouse | Warehouse location or identifier to request from the catalog service. May be used to determine server-side overrides, such as the warehouse location. |
355
380
356
381
<!-- markdown-link-check-enable-->
357
382
358
-
#### Headers in RESTCatalog
383
+
#### Common Integrations & Examples
359
384
360
-
To configure custom headers in RESTCatalog, include them in the catalog properties with the prefix `header.`. This
361
-
ensures that all HTTP requests to the REST service include the specified headers.
| `header.X-Iceberg-Access-Delegation` | `{vended-credentials,remote-signing}` | `vended-credentials` | Signal to the server that the client supports delegated access via a comma-separated list of access mechanisms. The server may choose to supply access via any or none of the requested mechanisms |
0 commit comments