Skip to content

[FLINK-39284][table] CREATE OR ALTER MATERIALIZED TABLE doesn't respect schema of existing table #27807

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
snuyanzin wants to merge 6 commits into
base: master
Choose a base branch
from
+703 −255
Open

[FLINK-39284][table] CREATE OR ALTER MATERIALIZED TABLE doesn't respect schema of existing table #27807

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
f688d9f
[FLINK-39284][table] Extract test for `CREATE OR ALTER MATERIALIZED T…
snuyanzin Mar 24, 2026
3581e5e
[FLINK-39284][table] Make `CREATE OR ALTER MATERIALIZED TABLE` respec…
snuyanzin Mar 24, 2026
3aafc1d
[FLINK-39284][table] Nullify types for columns while `CREATE OR ALTER…
snuyanzin Mar 24, 2026
8c92852
[FLINK-39284][table] Make `CREATE OR ALTER MATERIALIZED TABLE` respec…
snuyanzin Mar 24, 2026
521d804
[FLINK-39284][table] Make `CREATE OR ALTER MATERIALIZED TABLE` respec…
snuyanzin Mar 24, 2026
c824381
[hotfix][table] Use two spaces for `MODIFY DEFINITION QUERY`
snuyanzin Mar 24, 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
4 changes: 3 additions & 1 deletion ...i-java/src/main/java/org/apache/flink/table/operations/ddl/AlterTableChangeOperation.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,9 @@ public static String toString(TableChange tableChange) {
return String.format(
" MODIFY %s COMMENT '%s'",
EncodingUtils.escapeIdentifier(modifyColumnComment.getNewColumn().getName()),
modifyColumnComment.getNewComment());
modifyColumnComment.getNewComment() == null
Copy link
Contributor

@AHeise AHeise Mar 23, 2026

Choose a reason for hiding this comment

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

2-3 commits before, we already had some changes to the comment logic. Can you double-check if the commits are correctly cut?

Copy link
Contributor Author

@snuyanzin snuyanzin Mar 25, 2026

Choose a reason for hiding this comment

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

yep, fixed

? ""
: modifyColumnComment.getNewComment());
Comment on lines +100 to +102
Copy link
Contributor

@raminqaf raminqaf Mar 23, 2026

Choose a reason for hiding this comment

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

Shouldn't we avoid MODIFY COMMENT if the comment is null, instead of returning:

MODIFY 'id' COMMENT ''

Copy link
Contributor Author

@snuyanzin snuyanzin Mar 23, 2026

Choose a reason for hiding this comment

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

no, this type modification means it is removed
since there is no a dedicated table change for that

Copy link
Contributor

@raminqaf raminqaf Mar 23, 2026

Choose a reason for hiding this comment

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

Got it thanks!

} else if (tableChange instanceof TableChange.ModifyPhysicalColumnType) {
TableChange.ModifyPhysicalColumnType modifyPhysicalColumnType =
(TableChange.ModifyPhysicalColumnType) tableChange;
Expand Down
2 changes: 1 addition & 1 deletion ...pache/flink/table/operations/materializedtable/AlterMaterializedTableChangeOperation.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@ private static String toString(TableChange tableChange) {
} else if (tableChange instanceof ModifyDefinitionQuery) {
ModifyDefinitionQuery definitionQuery = (ModifyDefinitionQuery) tableChange;
return String.format(
" MODIFY DEFINITION QUERY TO '%s'", definitionQuery.getDefinitionQuery());
" MODIFY DEFINITION QUERY TO '%s'", definitionQuery.getDefinitionQuery());
} else {
return AlterTableChangeOperation.toString(tableChange);
}
Expand Down
136 changes: 99 additions & 37 deletions ...r/operations/converters/materializedtable/SqlCreateOrAlterMaterializedTableConverter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,14 +24,15 @@
import org.apache.flink.table.api.ValidationException;
import org.apache.flink.table.catalog.CatalogBaseTable.TableKind;
import org.apache.flink.table.catalog.CatalogMaterializedTable.RefreshMode;
import org.apache.flink.table.catalog.Column;
import org.apache.flink.table.catalog.ObjectIdentifier;
import org.apache.flink.table.catalog.ResolvedCatalogBaseTable;
import org.apache.flink.table.catalog.ResolvedCatalogMaterializedTable;
import org.apache.flink.table.catalog.ResolvedSchema;
import org.apache.flink.table.catalog.SchemaResolver;
import org.apache.flink.table.catalog.TableChange;
import org.apache.flink.table.catalog.TableDistribution;
import org.apache.flink.table.catalog.UniqueConstraint;
import org.apache.flink.table.catalog.WatermarkSpec;
import org.apache.flink.table.operations.Operation;
import org.apache.flink.table.operations.materializedtable.CreateMaterializedTableOperation;
import org.apache.flink.table.operations.materializedtable.FullAlterMaterializedTableOperation;
Expand Down Expand Up @@ -123,55 +124,116 @@ private Operation handleCreate(
private Function<ResolvedCatalogMaterializedTable, List<TableChange>> buildTableChanges(
final MergeContext mergeContext, final SchemaResolver schemaResolver) {
return oldTable -> {
final List<TableChange> changes = new ArrayList<>();
final List<TableChange> changes =
getSchemaTableChanges(mergeContext, schemaResolver, oldTable);

final ResolvedSchema oldSchema = oldTable.getResolvedSchema();
final List<Column> newColumns =
MaterializedTableUtils.validateAndExtractNewColumns(
oldSchema,
schemaResolver.resolve(mergeContext.getMergedSchema()),
mergeContext.hasSchemaDefinition());
changes.addAll(getQueryTableChanges(mergeContext, oldTable));
changes.addAll(getOptionsTableChanges(mergeContext, oldTable));
changes.addAll(getDistributionTableChanges(mergeContext, oldTable));

newColumns.forEach(column -> changes.add(TableChange.add(column)));
changes.add(
TableChange.modifyDefinitionQuery(
mergeContext.getMergedOriginalQuery(),
mergeContext.getMergedExpandedQuery()));
final RefreshMode oldRefreshMode = oldTable.getRefreshMode();
final RefreshMode newRefreshMode = mergeContext.getMergedRefreshMode();
if (oldRefreshMode != newRefreshMode && newRefreshMode != null) {
throw new ValidationException("Changing of REFRESH MODE is unsupported");
}

return changes;
};
}

final Map<String, String> oldOptions = oldTable.getOptions();
final Map<String, String> newOptions = mergeContext.getMergedTableOptions();
private List<TableChange> getDistributionTableChanges(
final MergeContext mergeContext, final ResolvedCatalogMaterializedTable oldTable) {
final TableDistribution oldDistribution = oldTable.getDistribution().orElse(null);
final TableDistribution newDistribution =
mergeContext.getMergedTableDistribution().orElse(null);
if (!Objects.equals(oldDistribution, newDistribution)) {
if (oldDistribution == null) {
return List.of(TableChange.add(newDistribution));
} else if (newDistribution == null) {
return List.of(TableChange.dropDistribution());
} else {
return List.of(TableChange.modify(newDistribution));
}
}
return List.of();
}

private List<TableChange> getOptionsTableChanges(
final MergeContext mergeContext, final ResolvedCatalogMaterializedTable oldTable) {
final List<TableChange> changes = new ArrayList<>();
final Map<String, String> oldOptions = oldTable.getOptions();
final Map<String, String> newOptions = mergeContext.getMergedTableOptions();

for (Map.Entry<String, String> newOptionEntry : newOptions.entrySet()) {
for (Map.Entry<String, String> newOptionEntry : newOptions.entrySet()) {
if (!newOptionEntry.getValue().equals(oldOptions.get(newOptionEntry.getKey()))) {
changes.add(TableChange.set(newOptionEntry.getKey(), newOptionEntry.getValue()));
}
}

for (Map.Entry<String, String> oldOptionEntry : oldOptions.entrySet()) {
if (newOptions.get(oldOptionEntry.getKey()) == null) {
changes.add(TableChange.reset(oldOptionEntry.getKey()));
}
for (Map.Entry<String, String> oldOptionEntry : oldOptions.entrySet()) {
if (newOptions.get(oldOptionEntry.getKey()) == null) {
changes.add(TableChange.reset(oldOptionEntry.getKey()));
}
}
return changes;
}

final RefreshMode oldRefreshMode = oldTable.getRefreshMode();
final RefreshMode newRefreshMode = mergeContext.getMergedRefreshMode();
if (oldRefreshMode != newRefreshMode && newRefreshMode != null) {
throw new ValidationException("Changing of REFRESH MODE is unsupported");
private List<TableChange> getQueryTableChanges(
final MergeContext mergeContext, final ResolvedCatalogMaterializedTable oldTable) {
final String originalQuery = oldTable.getOriginalQuery();
final String expandedQuery = oldTable.getExpandedQuery();
if (!originalQuery.equals(mergeContext.getMergedOriginalQuery())
|| !expandedQuery.equals(mergeContext.getMergedExpandedQuery())) {
return List.of(
TableChange.modifyDefinitionQuery(
mergeContext.getMergedOriginalQuery(),
mergeContext.getMergedExpandedQuery()));
}
return List.of();
}

private List<TableChange> getSchemaTableChanges(
final MergeContext mergeContext,
final SchemaResolver schemaResolver,
final ResolvedCatalogMaterializedTable oldTable) {
final ResolvedSchema oldSchema = oldTable.getResolvedSchema();
final ResolvedSchema newSchema = schemaResolver.resolve(mergeContext.getMergedSchema());
final List<TableChange> changes =
new ArrayList<>(
MaterializedTableUtils.validateAndExtractColumnChanges(
oldSchema, newSchema, mergeContext.hasSchemaDefinition()));

final UniqueConstraint oldConstraint = oldSchema.getPrimaryKey().orElse(null);
final UniqueConstraint newConstraint = newSchema.getPrimaryKey().orElse(null);
if (!Objects.equals(oldConstraint, newConstraint)) {
if (newConstraint == null) {
changes.add(TableChange.dropConstraint(oldConstraint.getName()));
} else if (oldConstraint == null) {
changes.add(TableChange.add(newConstraint));
} else {
changes.add(TableChange.modify(newConstraint));
}
}

final TableDistribution oldDistribution = oldTable.getDistribution().orElse(null);
final TableDistribution newDistribution =
mergeContext.getMergedTableDistribution().orElse(null);
if (!Objects.equals(oldDistribution, newDistribution)) {
if (oldDistribution == null) {
changes.add(TableChange.add(newDistribution));
} else if (newDistribution == null) {
changes.add(TableChange.dropDistribution());
} else {
changes.add(TableChange.modify(newDistribution));
}
final WatermarkSpec oldWatermarkSpec =
oldSchema.getWatermarkSpecs().isEmpty()
? null
: oldSchema.getWatermarkSpecs().get(0);
final WatermarkSpec newWatermarkSpec =
newSchema.getWatermarkSpecs().isEmpty()
? null
: newSchema.getWatermarkSpecs().get(0);
if (!Objects.equals(oldWatermarkSpec, newWatermarkSpec)) {
if (newWatermarkSpec == null) {
changes.add(TableChange.dropWatermark());
} else if (oldWatermarkSpec == null) {
changes.add(TableChange.add(newWatermarkSpec));
} else {
changes.add(TableChange.modify(newWatermarkSpec));
}
}

return changes;
};
return changes;
}

@Override
Expand Down
57 changes: 42 additions & 15 deletions ...le-planner/src/main/java/org/apache/flink/table/planner/utils/MaterializedTableUtils.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,12 +38,14 @@
import org.apache.flink.table.catalog.TableChange.ColumnPosition;
import org.apache.flink.table.planner.operations.PlannerQueryOperation;
import org.apache.flink.table.planner.operations.converters.SqlNodeConverter.ConvertContext;
import org.apache.flink.table.types.DataType;

import org.apache.calcite.sql.SqlIntervalLiteral;
import org.apache.calcite.sql.SqlIntervalLiteral.IntervalValue;
import org.apache.calcite.sql.SqlNode;
import org.apache.calcite.sql.SqlNodeList;
import org.apache.calcite.sql.type.SqlTypeFamily;
import org.apache.commons.lang3.StringUtils;

import java.util.ArrayList;
import java.util.HashMap;
Expand Down Expand Up @@ -278,7 +280,7 @@ private static void applyMetadataColumnChanges(
}
}

public static List<Column> validateAndExtractNewColumns(
public static List<TableChange> validateAndExtractColumnChanges(
ResolvedSchema oldSchema, ResolvedSchema newSchema, boolean schemaDefinedInQuery) {
final List<Column> newColumns = getPersistedColumns(newSchema);
final List<Column> oldColumns = getPersistedColumns(oldSchema);
Expand All @@ -294,29 +296,54 @@ public static List<Column> validateAndExtractNewColumns(
originalColumnSize, newColumnSize));
}

final List<TableChange> columnChanges = new ArrayList<>();
for (int i = 0; i < oldColumns.size(); i++) {
Column oldColumn = oldColumns.get(i);
Column newColumn = newColumns.get(i);
final Column oldColumn = oldColumns.get(i);
final Column newColumn = newColumns.get(i);
final DataType newColumnDataType =
getNewColumnDatatype(oldColumn, newColumns.get(i), schemaDefinedInQuery);
if (!oldColumn.equals(newColumn)) {
throw new ValidationException(
String.format(
"When modifying the query of a materialized table, "
+ "currently only support appending columns at the end of original schema, dropping, renaming, and reordering columns are not supported.\n"
+ "Column mismatch at position %d: Original column is [%s], but new column is [%s].",
i, oldColumn, newColumn));
if (!oldColumn.getName().equals(newColumn.getName())
|| !oldColumn.getDataType().equals(newColumnDataType)) {
throw new ValidationException(
Copy link
Contributor

@AHeise AHeise Mar 23, 2026

Choose a reason for hiding this comment

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

Can we move the exception also to the operation and just issue a TableChange.ModifyPhysicalColumnType?

Copy link
Contributor Author

@snuyanzin snuyanzin Mar 25, 2026

Choose a reason for hiding this comment

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

it is already in a function, so the exception will be raised in operation

String.format(
"When modifying the query of a materialized table, "
+ "currently only support appending columns at the end of original schema, dropping, renaming, and reordering columns are not supported.\n"
+ "Column mismatch at position %d: Original column is [%s], but new column is [%s].",
i + 1, oldColumn, newColumn));
}
final String oldComment = oldColumn.getComment().orElse(null);
final String newComment = newColumn.getComment().orElse(null);

if (StringUtils.isEmpty(oldComment) != StringUtils.isEmpty(newComment)
|| StringUtils.isNotEmpty(oldComment)
&& !Objects.equals(oldComment, newComment)) {
columnChanges.add(TableChange.modifyColumnComment(oldColumn, newComment));
}
}
}

final List<Column> newAddedColumns = new ArrayList<>();
for (int i = oldColumns.size(); i < newColumns.size(); i++) {
Column newColumn = newColumns.get(i);
newAddedColumns.add(
schemaDefinedInQuery
? newColumn
: newColumn.copy(newColumn.getDataType().nullable()));
columnChanges.add(
TableChange.add(
schemaDefinedInQuery
? newColumn
: newColumn.copy(newColumn.getDataType().nullable())));
}

return newAddedColumns;
return columnChanges;
}

private static DataType getNewColumnDatatype(
Column oldColumn, Column newColumn, boolean schemaDefinedInQuery) {
if (schemaDefinedInQuery) {
return newColumn.getDataType();
}
if (oldColumn.getDataType().nullable().equals(newColumn.getDataType().nullable())) {
return oldColumn.getDataType();
}
return newColumn.getDataType();
}

public static ResolvedSchema getQueryOperationResolvedSchema(
Expand Down
Loading