Skip to content

Flink: Backport table comments fix to flink v1.20, v2.0 #16503

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

Merged
pvary merged 1 commit into from
May 21, 2026
Merged

Flink: Backport table comments fix to flink v1.20, v2.0 #16503

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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/v1.20/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
19 changes: 19 additions & 0 deletions flink/v1.20/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 @@ -47,6 +47,7 @@
import org.apache.iceberg.Snapshot;
import org.apache.iceberg.Table;
import org.apache.iceberg.TableOperations;
import org.apache.iceberg.TableProperties;
import org.apache.iceberg.catalog.TableIdentifier;
import org.apache.iceberg.exceptions.NoSuchTableException;
import org.apache.iceberg.relocated.com.google.common.collect.Iterables;
Expand Down Expand Up @@ -236,6 +237,24 @@ public void testCreateTableLikeInFlinkCatalog() throws TableNotExistException {
.containsEntry(FlinkCreateTableOptions.SRC_CATALOG_PROPS_KEY, srcCatalogProps);
}

@TestTemplate
public void testCreateTableWithTableComment() {
// create table with comment
sql("CREATE TABLE tl(id BIGINT) COMMENT 'table comment'");
assertThat(table("tl").properties()).containsEntry(TableProperties.COMMENT, "table comment");
}

@TestTemplate
public void testAlterTableModifyTableComment() {
// create table with comment
sql("CREATE TABLE tl(id BIGINT) COMMENT 'table comment'");
assertThat(table("tl").properties()).containsEntry(TableProperties.COMMENT, "table comment");

// alter table comment
sql("ALTER TABLE tl SET('comment' = 'new comment')");
assertThat(table("tl").properties()).containsEntry(TableProperties.COMMENT, "new comment");
}

@TestTemplate
public void testCreateTableLocation() {
assumeThat(isHadoopCatalog)
Expand Down
6 changes: 6 additions & 0 deletions flink/v2.0/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
19 changes: 19 additions & 0 deletions flink/v2.0/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 @@ -48,6 +48,7 @@
import org.apache.iceberg.Snapshot;
import org.apache.iceberg.Table;
import org.apache.iceberg.TableOperations;
import org.apache.iceberg.TableProperties;
import org.apache.iceberg.catalog.TableIdentifier;
import org.apache.iceberg.exceptions.NoSuchTableException;
import org.apache.iceberg.relocated.com.google.common.collect.Iterables;
Expand Down Expand Up @@ -243,6 +244,24 @@ public void testCreateTableLikeInFlinkCatalog() throws TableNotExistException {
.containsEntry(FlinkCreateTableOptions.SRC_CATALOG_PROPS_KEY, srcCatalogProps);
}

@TestTemplate
public void testCreateTableWithTableComment() {
// create table with comment
sql("CREATE TABLE tl(id BIGINT) COMMENT 'table comment'");
assertThat(table("tl").properties()).containsEntry(TableProperties.COMMENT, "table comment");
}

@TestTemplate
public void testAlterTableModifyTableComment() {
// create table with comment
sql("CREATE TABLE tl(id BIGINT) COMMENT 'table comment'");
assertThat(table("tl").properties()).containsEntry(TableProperties.COMMENT, "table comment");

// alter table comment
sql("ALTER TABLE tl SET('comment' = 'new comment')");
assertThat(table("tl").properties()).containsEntry(TableProperties.COMMENT, "new comment");
}

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