You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@flink.apache.org by GitBox <gi...@apache.org> on 2022/12/26 07:37:09 UTC
[GitHub] [flink] fsk119 commented on a diff in pull request #20652: [FLINK-22315][table] Support ADD column/constraint/watermark for ALTER TABLE statement
fsk119 commented on code in PR #20652:
URL: https://github.com/apache/flink/pull/20652#discussion_r1057106746
##########
flink-table/flink-table-planner/src/main/java/org/apache/flink/table/planner/operations/AlterSchemaConverter.java:
##########
@@ -0,0 +1,436 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.apache.flink.table.planner.operations;
+
+import org.apache.flink.sql.parser.ddl.SqlAlterTableAdd;
+import org.apache.flink.sql.parser.ddl.SqlAlterTableModify;
+import org.apache.flink.sql.parser.ddl.SqlAlterTableSchema;
+import org.apache.flink.sql.parser.ddl.SqlTableColumn;
+import org.apache.flink.sql.parser.ddl.SqlWatermark;
+import org.apache.flink.sql.parser.ddl.constraint.SqlTableConstraint;
+import org.apache.flink.sql.parser.ddl.position.SqlTableColumnPosition;
+import org.apache.flink.table.api.Schema;
+import org.apache.flink.table.api.ValidationException;
+import org.apache.flink.table.catalog.SchemaResolver;
+import org.apache.flink.table.expressions.SqlCallExpression;
+import org.apache.flink.table.planner.calcite.FlinkTypeFactory;
+import org.apache.flink.table.types.AbstractDataType;
+import org.apache.flink.table.types.DataType;
+import org.apache.flink.util.Preconditions;
+
+import org.apache.calcite.rel.type.RelDataType;
+import org.apache.calcite.sql.SqlCharStringLiteral;
+import org.apache.calcite.sql.SqlDataTypeSpec;
+import org.apache.calcite.sql.SqlIdentifier;
+import org.apache.calcite.sql.SqlNode;
+import org.apache.calcite.sql.validate.SqlValidator;
+
+import javax.annotation.Nullable;
+
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.HashMap;
+import java.util.HashSet;
+import java.util.List;
+import java.util.Map;
+import java.util.Optional;
+import java.util.Set;
+import java.util.function.Consumer;
+import java.util.function.Function;
+import java.util.stream.Collectors;
+
+import static org.apache.flink.table.planner.calcite.FlinkTypeFactory.toLogicalType;
+import static org.apache.flink.table.types.utils.TypeConversions.fromLogicalToDataType;
+
+/**
+ * Converter to convert {@link SqlAlterTableSchema} with source table to generate new {@link
+ * Schema}.
+ */
+public class AlterSchemaConverter {
+
+ private final SqlValidator sqlValidator;
+ private final Function<SqlNode, String> escapeExpression;
+ private final Consumer<SqlTableConstraint> constraintValidator;
+ private final SchemaResolver schemaResolver;
+
+ AlterSchemaConverter(
+ SqlValidator sqlValidator,
+ Consumer<SqlTableConstraint> constraintValidator,
+ Function<SqlNode, String> escapeExpression,
+ SchemaResolver schemaResolver) {
+ this.sqlValidator = sqlValidator;
+ this.escapeExpression = escapeExpression;
+ this.constraintValidator = constraintValidator;
+ this.schemaResolver = schemaResolver;
+ }
+
+ public Schema applySchemaChange(SqlAlterTableSchema alterTableSchema, Schema originalSchema) {
+ AlterSchemaStrategy strategy = computeAlterSchemaStrategy(alterTableSchema);
+ if (strategy == AlterSchemaStrategy.MODIFY) {
+ throw new UnsupportedOperationException("Not implemented yet");
+ }
+ SchemaConverter converter =
+ new AddSchemaConverter(
+ originalSchema,
+ (FlinkTypeFactory) sqlValidator.getTypeFactory(),
+ sqlValidator,
+ constraintValidator,
+ escapeExpression,
+ schemaResolver);
+ converter.updateColumn(alterTableSchema.getColumnPositions().getList());
+ alterTableSchema.getWatermark().ifPresent(converter::updateWatermark);
+ alterTableSchema.getFullConstraint().ifPresent(converter::updatePrimaryKey);
+ return converter.convert();
+ }
+
+ private abstract static class SchemaConverter {
+
+ static final String EX_MSG_PREFIX = "Failed to execute ALTER TABLE statement.\n";
+
+ List<String> sortedColumnNames = new ArrayList<>();
+ Set<String> alterColNames = new HashSet<>();
+ Map<String, Schema.UnresolvedColumn> columns = new HashMap<>();
+ @Nullable Schema.UnresolvedWatermarkSpec watermarkSpec = null;
+ @Nullable Schema.UnresolvedPrimaryKey primaryKey = null;
+
+ Function<SqlNode, String> escapeExpressions;
+ FlinkTypeFactory typeFactory;
+ SqlValidator sqlValidator;
+ Consumer<SqlTableConstraint> constraintValidator;
+ SchemaResolver schemaResolver;
+
+ SchemaConverter(
+ Schema originalSchema,
+ FlinkTypeFactory typeFactory,
+ SqlValidator sqlValidator,
+ Consumer<SqlTableConstraint> constraintValidator,
+ Function<SqlNode, String> escapeExpressions,
+ SchemaResolver schemaResolver) {
+ this.typeFactory = typeFactory;
+ this.sqlValidator = sqlValidator;
+ this.constraintValidator = constraintValidator;
+ this.escapeExpressions = escapeExpressions;
+ this.schemaResolver = schemaResolver;
+ populateColumnsFromSourceTable(originalSchema);
+ populatePrimaryKeyFromSourceTable(originalSchema);
+ populateWatermarkFromSourceTable(originalSchema);
+ }
+
+ private void populateColumnsFromSourceTable(Schema originalSchema) {
+ originalSchema
+ .getColumns()
+ .forEach(
+ column -> {
+ String name = column.getName();
+ sortedColumnNames.add(name);
+ columns.put(name, column);
+ });
+ }
+
+ private void populatePrimaryKeyFromSourceTable(Schema originalSchema) {
+ if (originalSchema.getPrimaryKey().isPresent()) {
+ primaryKey = originalSchema.getPrimaryKey().get();
+ }
+ }
+
+ private void populateWatermarkFromSourceTable(Schema originalSchema) {
+ for (Schema.UnresolvedWatermarkSpec sourceWatermarkSpec :
+ originalSchema.getWatermarkSpecs()) {
+ watermarkSpec = sourceWatermarkSpec;
+ }
+ }
+
+ private void updateColumn(List<SqlNode> alterColumnPositions) {
+ applyColumnPosition(alterColumnPositions);
+ for (SqlNode alterColumnPos : alterColumnPositions) {
+ SqlTableColumn alterColumn = ((SqlTableColumnPosition) alterColumnPos).getColumn();
+ Schema.UnresolvedColumn newColumn;
+ if (alterColumn instanceof SqlTableColumn.SqlComputedColumn) {
+ newColumn =
+ convertComputedColumn((SqlTableColumn.SqlComputedColumn) alterColumn);
+ } else if (alterColumn instanceof SqlTableColumn.SqlMetadataColumn) {
+ newColumn =
+ convertMetadataColumn((SqlTableColumn.SqlMetadataColumn) alterColumn);
+ } else if (alterColumn instanceof SqlTableColumn.SqlRegularColumn) {
+ newColumn =
+ convertPhysicalColumn((SqlTableColumn.SqlRegularColumn) alterColumn);
+ } else {
+ throw new UnsupportedOperationException(
+ String.format(
+ "Unsupported sql table column class: %s",
+ alterColumn.getClass().getCanonicalName()));
+ }
+ columns.put(newColumn.getName(), newColumn);
+ }
+ }
+
+ private void updatePrimaryKey(SqlTableConstraint alterPrimaryKey) {
+ checkPrimaryKeyExists();
+ constraintValidator.accept(alterPrimaryKey);
+ List<String> primaryKeyColumns = Arrays.asList(alterPrimaryKey.getColumnNames());
+ if (alterColNames.isEmpty()) {
+ primaryKeyColumns.forEach(this::updatePrimaryKeyNullability);
+ }
+ primaryKey =
+ new Schema.UnresolvedPrimaryKey(
+ alterPrimaryKey
+ .getConstraintName()
+ .orElseGet(
+ () ->
+ primaryKeyColumns.stream()
+ .collect(
+ Collectors.joining(
+ "_", "PK_", ""))),
+ primaryKeyColumns);
+ }
+
+ private void updatePrimaryKeyNullability(String columnName) {
+ Schema.UnresolvedColumn column = columns.get(columnName);
+ if (column instanceof Schema.UnresolvedPhysicalColumn) {
+ AbstractDataType<?> originalType =
+ ((Schema.UnresolvedPhysicalColumn) column).getDataType();
+ columns.put(
+ columnName,
+ new Schema.UnresolvedPhysicalColumn(
+ columnName,
+ originalType.notNull(),
+ column.getComment().orElse(null)));
+ }
+ }
+
+ private void updateWatermark(SqlWatermark alterWatermarkSpec) {
+ checkWatermarkExists();
+ SqlIdentifier eventTimeColumnName = alterWatermarkSpec.getEventTimeColumnName();
+ if (!eventTimeColumnName.isSimple()) {
+ throw new ValidationException(
+ String.format(
+ "%sWatermark strategy on nested column is not supported yet.",
+ EX_MSG_PREFIX));
+ }
+ watermarkSpec =
+ new Schema.UnresolvedWatermarkSpec(
+ eventTimeColumnName.getSimple(),
+ new SqlCallExpression(
+ escapeExpressions.apply(
+ alterWatermarkSpec.getWatermarkStrategy())));
+ }
+
+ private Schema.UnresolvedPhysicalColumn convertPhysicalColumn(
+ SqlTableColumn.SqlRegularColumn physicalColumn) {
+ DataType dataType = getDataType(physicalColumn.getType());
+ return new Schema.UnresolvedPhysicalColumn(
+ physicalColumn.getName().getSimple(), dataType, getComment(physicalColumn));
+ }
+
+ private Schema.UnresolvedMetadataColumn convertMetadataColumn(
+ SqlTableColumn.SqlMetadataColumn metadataColumn) {
+ DataType dataType = getDataType(metadataColumn.getType());
+ return new Schema.UnresolvedMetadataColumn(
+ metadataColumn.getName().getSimple(),
+ dataType,
+ metadataColumn.getMetadataAlias().orElse(null),
+ metadataColumn.isVirtual(),
+ getComment(metadataColumn));
+ }
+
+ private Schema.UnresolvedComputedColumn convertComputedColumn(
+ SqlTableColumn.SqlComputedColumn column) {
+ return new Schema.UnresolvedComputedColumn(
+ column.getName().getSimple(),
+ new SqlCallExpression(escapeExpressions.apply(column.getExpr())),
+ getComment(column));
+ }
+
+ private DataType getDataType(SqlDataTypeSpec typeSpec) {
+ RelDataType relType =
+ typeSpec.deriveType(
+ sqlValidator, typeSpec.getNullable() == null || typeSpec.getNullable());
+ return fromLogicalToDataType(toLogicalType(relType));
+ }
+
+ @Nullable
+ String getComment(SqlTableColumn column) {
+ return column.getComment()
+ .map(SqlCharStringLiteral.class::cast)
+ .map(c -> c.getValueAs(String.class))
+ .orElse(null);
+ }
+
+ private void applyColumnPosition(List<SqlNode> alterColumns) {
+ for (SqlNode alterColumn : alterColumns) {
+ SqlTableColumnPosition columnPosition = (SqlTableColumnPosition) alterColumn;
+ SqlTableColumn column = columnPosition.getColumn();
+ if (!column.getName().isSimple()) {
+ throw new UnsupportedOperationException(
+ String.format(
+ "%sAlter nested row type is not supported yet.",
+ EX_MSG_PREFIX));
+ }
+ String columnName = column.getName().getSimple();
+ if (!alterColNames.add(columnName)) {
+ throw new ValidationException(
+ String.format(
+ "%sEncounter duplicate column `%s`.",
+ EX_MSG_PREFIX, columnName));
+ }
+ checkColumnExists(columnName);
+ getColumnPosition(columnPosition)
+ .ifPresent(pos -> sortedColumnNames.add(pos, columnName));
+ }
+ }
+
+ Optional<Integer> getColumnPosition(SqlTableColumnPosition columnPosition) {
+ int pos = sortedColumnNames.size();
+ if (columnPosition.isFirstColumn()) {
+ pos = 0;
+ } else if (columnPosition.isAfterReferencedColumn()) {
+ pos = sortedColumnNames.indexOf(getReferencedColumn(columnPosition)) + 1;
+ }
+ return Optional.of(pos);
+ }
+
+ private String getReferencedColumn(SqlTableColumnPosition columnPosition) {
+ SqlIdentifier referencedIdent = columnPosition.getAfterReferencedColumn();
+ Preconditions.checkNotNull(
+ referencedIdent,
+ String.format("%sCould not refer to a null column", EX_MSG_PREFIX));
+ if (!referencedIdent.isSimple()) {
+ throw new UnsupportedOperationException(
+ String.format(
+ "%sAlter nested row type is not supported yet.", EX_MSG_PREFIX));
+ }
+ String referencedName = referencedIdent.getSimple();
+ if (!sortedColumnNames.contains(referencedName)) {
+ throw new ValidationException(
+ String.format(
+ "%sReferenced column `%s` by 'AFTER' does not exist in the table.",
+ EX_MSG_PREFIX, referencedName));
+ }
+ return referencedName;
+ }
+
+ private Schema convert() {
+ List<Schema.UnresolvedColumn> newColumns = new ArrayList<>();
+ for (String column : sortedColumnNames) {
+ newColumns.add(columns.get(column));
+ }
+ Schema.Builder resultBuilder = Schema.newBuilder().fromColumns(newColumns);
+ if (primaryKey != null) {
+ String constraintName = primaryKey.getConstraintName();
+ List<String> pkColumns = primaryKey.getColumnNames();
+ if (constraintName != null) {
+ resultBuilder.primaryKeyNamed(constraintName, pkColumns);
+ } else {
+ resultBuilder.primaryKey(pkColumns);
+ }
+ }
+ if (watermarkSpec != null) {
+ resultBuilder.watermark(
+ watermarkSpec.getColumnName(), watermarkSpec.getWatermarkExpression());
+ }
+ Schema updatedSchema = resultBuilder.build();
+ try {
+ schemaResolver.resolve(updatedSchema);
+ return updatedSchema;
+ } catch (Exception e) {
+ throw new ValidationException(String.format("%s%s", EX_MSG_PREFIX, e.getMessage()));
Review Comment:
throw new ValidationException(String.format("%s%s", EX_MSG_PREFIX, e.getMessage()), e);
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org