Skip to content

Flink: Table comment bug #16423

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
SteveStevenpoor wants to merge 3 commits into
base: main
Choose a base branch
from
+25 −0
Open

Flink: Table comment bug #16423

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7412661
Flink: Table comment bug
SteveStevenpoor May 18, 2026
f23bb69
Flink: Split tests
SteveStevenpoor May 20, 2026
60b2cf3
Flink: Get rid of unnecessary map
SteveStevenpoor May 20, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions flink/v2.1/flink/src/main/java/org/apache/iceberg/flink/FlinkCatalog.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,7 @@
import org.apache.iceberg.Schema;
import org.apache.iceberg.StructLike;
import org.apache.iceberg.Table;
import org.apache.iceberg.TableProperties;
import org.apache.iceberg.catalog.Catalog;
import org.apache.iceberg.catalog.Namespace;
import org.apache.iceberg.catalog.SupportsNamespaces;
Expand Down Expand Up @@ -450,6 +451,11 @@ void createIcebergTable(ObjectPath tablePath, ResolvedCatalogTable table, boolea
}
}

String comment = table.getComment();
if (comment != null && !comment.isEmpty()) {
properties.put(TableProperties.COMMENT, comment);
}

try {
icebergCatalog.createTable(
toIdentifier(tablePath), icebergSchema, spec, location, properties.build());
Expand Down
20 changes: 20 additions & 0 deletions flink/v2.1/flink/src/test/java/org/apache/iceberg/flink/TestFlinkCatalogTable.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -243,6 +243,26 @@ public void testCreateTableLikeInFlinkCatalog() throws TableNotExistException {
.containsEntry(FlinkCreateTableOptions.SRC_CATALOG_PROPS_KEY, srcCatalogProps);
}

@TestTemplate
public void testCreateTableComment() {
Copy link
Copy Markdown
Contributor

@pvary pvary May 19, 2026

Choose a reason for hiding this comment

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

I would create the following tests:
testCreateTableWithTableComment
testAlterTableModifyTableComment

I'm not sure why the alter parameter is here in this test

// create table with comment
sql("CREATE TABLE tl(id BIGINT) COMMENT 'table comment' WITH ('param'='some value')");
Map<String, String> properties = Maps.newHashMap();
properties.put("comment", "table comment");
properties.put("param", "some value");
assertThat(table("tl").properties()).containsAllEntriesOf(properties);

// update parameter
sql("ALTER TABLE tl SET('param'='new value')");
properties.put("param", "new value");
assertThat(table("tl").properties()).containsAllEntriesOf(properties);
Copy link
Copy Markdown
Contributor

@pvary pvary May 20, 2026

Choose a reason for hiding this comment

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

Suggested change
assertThat(table("tl").properties()).containsAllEntriesOf(properties);
assertThat(table("tl").properties()).containsEntry(TableProperties.COMMENT, "table comment");

And then we don't need the extra Map


// alter table comment
sql("ALTER TABLE tl SET('comment' = 'new comment')");
properties.put("comment", "new comment");
assertThat(table("tl").properties()).containsAllEntriesOf(properties);
Copy link
Copy Markdown
Contributor

@pvary pvary May 20, 2026

Choose a reason for hiding this comment

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

Same as above

}

@TestTemplate
public void testCreateTableLocation() {
assumeThat(isHadoopCatalog)
Expand Down