This is an automated email from the ASF dual-hosted git repository.
kevinjqliu pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/iceberg.git
The following commit(s) were added to refs/heads/main by this push:
new d7aa46724c Docs: Add informational properties section for table
comment (#15367)
d7aa46724c is described below
commit d7aa46724c25e732e8f1bac20649ce11207475d7
Author: yguy-ryft <[email protected]>
AuthorDate: Thu Feb 26 00:22:36 2026 +0200
Docs: Add informational properties section for table comment (#15367)
---
docs/docs/configuration.md | 8 ++++++++
1 file changed, 8 insertions(+)
diff --git a/docs/docs/configuration.md b/docs/docs/configuration.md
index fc26ebab57..00e8ed8373 100644
--- a/docs/docs/configuration.md
+++ b/docs/docs/configuration.md
@@ -127,6 +127,14 @@ The value of these properties are not persisted as a part
of the table metadata.
| -------------- | --------
|--------------------------------------------------------------------------------------------------------------------------------------|
| format-version | 2 | Table's format version as defined in the
[Spec](../../spec.md#format-versioning). Defaults to 2 since version 1.4.0. |
+### Informational properties
+
+Informational properties can be set to provide additional context about a
table. They can be useful for documentation, discovery, and integration with
external tools. They do not affect read/write behavior or query semantics.
+
+| Property | Default | Description
|
+| -------- | ---------- |
-------------------------------------------------------------------------------------------------------------------
|
+| comment | (not set) | A table-level description that documents the
business meaning and usage context. |
+
### Compatibility flags
| Property | Default | Description
|
