Skip to content

Docs: Add Amazon S3 Tables catalog section - #4166

Open
athenawemmert wants to merge 2 commits into
apache:mainfrom
athenawemmert:docs-s3-tables
Open

athenawemmert wants to merge 2 commits into
apache:mainfrom
athenawemmert:docs-s3-tables

Conversation

@athenawemmert

Copy link
Copy Markdown

Rationale for this change

The configuration docs reach Amazon S3 Tables only through the AWS Glue example (s3tablescatalog warehouse). Connecting PyIceberg straight to the S3 Tables Iceberg REST endpoint needs two non-default keys that are easy to miss: the warehouse is the table bucket ARN, and rest.signing-name must be s3tables (PyIceberg defaults to execute-api).

This adds an Amazon S3 Tables entry under "Common Integrations & Examples", next to AWS Glue, in the same shape as the other REST integrations: a link to the AWS docs and the catalog YAML.

Are these changes tested?

Docs only. I used this configuration against a real S3 Tables table bucket in us-west-2 with PyIceberg 0.12.0 (pyiceberg[pyarrow,rest-sigv4]): create namespace, create table, append, and scan all succeeded, with requests signed for s3tables. markdownlint and codespell pass, and mkdocs build --strict succeeds.

I used an AI assistant to draft the section and the test harness, then reviewed the text and checked each key against the AWS docs, the PyIceberg source, and the live run. I only tested us-west-2.

Are there any user-facing changes?

Documentation only.

Add the S3 Tables Iceberg REST endpoint to Common Integrations, next to
AWS Glue, in the same shape as the other REST integrations: a link to
the AWS docs and the catalog YAML. The warehouse is the table bucket
ARN and the signing name is s3tables, not the execute-api default.
Comment on lines 582 to 583
##### AWS Glue

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

love that. added it!!

This branch has not been deployed

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants