Skip to content

Conversation

@kbatuigas
Copy link
Contributor

@kbatuigas kbatuigas commented Oct 9, 2025

Description

This pull request adds an important clarification to the documentation for AWS Glue integration, specifically regarding field naming requirements. The update highlights a limitation that requires all table column names to be lowercase to avoid schema matching errors.

Documentation update for AWS Glue integration:

  • Added a new section explaining that only lowercase field names are supported, as AWS Glue automatically converts all column names to lowercase. This prevents errors in Redpanda when matching columns for schema management.

Resolves https://redpandadata.atlassian.net/browse/1748
Review deadline:

Page previews

https://deploy-preview-1387--redpanda-docs-preview.netlify.app/current/manage/iceberg/iceberg-topics-aws-glue/#lowercase-field-names-required

Checks

  • New feature
  • Content gap
  • Support Follow-up
  • Small fix (typos, links, copyedits, etc)

@kbatuigas kbatuigas requested a review from a team as a code owner October 9, 2025 23:54
@netlify
Copy link

netlify bot commented Oct 9, 2025

Deploy Preview for redpanda-docs-preview ready!

Name Link
🔨 Latest commit 4b95d76
🔍 Latest deploy log https://app.netlify.com/projects/redpanda-docs-preview/deploys/68e94af186884a0008475164
😎 Deploy Preview https://deploy-preview-1387--redpanda-docs-preview.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Oct 9, 2025

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

📝 Walkthrough

Walkthrough

Adds new guidance and examples to the Iceberg AWS Glue documentation (modules/manage/pages/iceberg/iceberg-topics-aws-glue.adoc): a limitation requiring lowercase field names; expanded notes on nested partition specs and default partitioning behavior; a prerequisite to include the S3 bucket URI for the Glue Data Catalog base location; updates to cluster configuration steps and examples (including rpk commands and iceberg-related properties); topic creation/alter examples with redpanda.iceberg.mode; produce/query examples showing AWS Glue/Athena usage and expected data format; and updated placeholders for region, bucket, and credentials.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

Suggested reviewers

  • simon0191
  • wdberkeley
  • Feediver1
  • mattschumpert

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)
Check name Status Explanation Resolution
Out of Scope Changes Check ⚠️ Warning In addition to the lowercase field name guidance, the pull request introduces unrelated content such as nested partition spec details, S3 prerequisite notes, cluster configuration examples, and Athena query snippets that are outside the scope of DOC-1748. Please isolate or remove the unrelated documentation changes and focus this pull request solely on the lowercase field name requirement, moving additional topics to separate issues or pull requests.
✅ Passed checks (4 passed)
Check name Status Explanation
Title Check ✅ Passed The title succinctly and accurately reflects the primary change by stating that lowercase field names are required for AWS Glue integration, which matches the core update in the pull request. It is concise, clear, and directly related to the documented limitation without unnecessary detail or noise.
Linked Issues Check ✅ Passed The documentation update clearly adds the lowercase field name requirement as specified in DOC-1748, directly addressing the linked issue’s objective to document that all column names must be lowercase for AWS Glue integration.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
Description Check ✅ Passed The provided pull request description includes all sections defined in the repository template: a clear Description with change context, a Jira issue resolution link, a Review deadline placeholder, a working Page previews URL, and the Checks list, so it largely conforms to the required structure.

Comment @coderabbitai help to get the list of available commands and usage tips.

@kbatuigas kbatuigas requested a review from nvartolomei October 9, 2025 23:54

=== Lowercase field names required

You must use only lowercase field names. AWS Glue automatically converts all table column names to lowercase. Redpanda matches columns by name for schema management, and using uppercase letters can cause errors when Redpanda can't find matching columns.
Copy link
Contributor

Choose a reason for hiding this comment

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

Replace can cause errors... with breaks schema management (end of sentence).

It is certain that it will break.

@kbatuigas kbatuigas requested a review from nvartolomei October 10, 2025 16:26

=== Lowercase field names required

You must use only lowercase field names. AWS Glue automatically converts all table column names to lowercase. Redpanda relies on exact column name matching to manage schemas, and using uppercase letters can break schema management when Redpanda can't find matching columns.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
You must use only lowercase field names. AWS Glue automatically converts all table column names to lowercase. Redpanda relies on exact column name matching to manage schemas, and using uppercase letters can break schema management when Redpanda can't find matching columns.
Use only lowercase field names. AWS Glue converts all table column names to lowercase, and Redpanda requires exact column name matches for schema management. Using uppercase letters will prevent Redpanda from finding matching columns and break schema management.

Slight change to enforce active voice. Feel free to reject parts that you don't agree

Copy link
Collaborator

@paulohtb6 paulohtb6 left a comment

Choose a reason for hiding this comment

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

minor nit on wording.

@kbatuigas kbatuigas merged commit 49f3198 into main Oct 10, 2025
7 checks passed
@kbatuigas kbatuigas deleted the DOC-1748-glue-catalog-lowercase-field-name-requirement branch October 10, 2025 18:12
@nvartolomei
Copy link
Contributor

🔥

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.

4 participants