Skip to content

Docs: Add informational properties section for table comment - #15367

Merged
kevinjqliu merged 2 commits into
apache:mainfrom
yguy-ryft:docs-informational-properties
Feb 25, 2026
Merged

kevinjqliu merged 2 commits into
apache:mainfrom
yguy-ryft:docs-informational-properties

Conversation

@yguy-ryft

@yguy-ryft yguy-ryft commented Feb 19, 2026 •

Copy link
Copy Markdown
Contributor
  • Adds a new "Informational properties" section to the table properties documentation
  • Documents the comment property, which engines like Spark and Flink set via COMMENT in CREATE TABLE DDL
  • This follows a discussion on the dev mailing list about standardizing documentation for properties like comment that provide semantic context about a table - https://lists.apache.org/thread/5q92y3dlnc3mb5b2cj72hzs6xmy3xtfl
  • Ran locally and the section was rendered properly:
image

@github-actions github-actions Bot added the docs label Feb 19, 2026
Comment thread docs/docs/configuration.md Outdated
Comment thread docs/docs/configuration.md Outdated
Comment thread docs/docs/configuration.md
Updated the description of informational properties and the comment property for clarity.
@yguy-ryft
yguy-ryft requested a review from stevenzwu February 22, 2026 16:31
@yguy-ryft

Copy link
Copy Markdown
Contributor Author

@stevenzwu your suggestions were great, I replaced the texts with them - thanks!

@singhpk234 singhpk234 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM too !

@kevinjqliu kevinjqliu left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

lgtm lets move this forward

rendered locally,
Screenshot 2026-02-25 at 2 22 00 PM

@kevinjqliu
kevinjqliu merged commit d7aa467 into apache:main Feb 25, 2026
4 checks passed
RjLi13 pushed a commit to RjLi13/iceberg that referenced this pull request Mar 12, 2026
talatuyarer pushed a commit to talatuyarer/iceberg that referenced this pull request Apr 1, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants