yunfengzhou-hub commented on code in PR #6532: URL: https://github.com/apache/paimon/pull/6532#discussion_r2508522857
########## paimon-flink/paimon-flink-cdc/src/main/java/org/apache/paimon/flink/pipeline/cdc/schema/PaimonMetadataApplier.java: ########## @@ -0,0 +1,380 @@ +/* + * 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.paimon.flink.pipeline.cdc.schema; + +import org.apache.paimon.catalog.Catalog; +import org.apache.paimon.catalog.Identifier; +import org.apache.paimon.flink.FlinkCatalog; +import org.apache.paimon.flink.FlinkCatalogFactory; +import org.apache.paimon.flink.LogicalTypeConversion; +import org.apache.paimon.options.Options; +import org.apache.paimon.schema.SchemaChange; +import org.apache.paimon.table.Table; +import org.apache.paimon.table.sink.BatchTableCommit; + +import org.apache.flink.cdc.common.event.AddColumnEvent; +import org.apache.flink.cdc.common.event.AlterColumnTypeEvent; +import org.apache.flink.cdc.common.event.CreateTableEvent; +import org.apache.flink.cdc.common.event.DropColumnEvent; +import org.apache.flink.cdc.common.event.DropTableEvent; +import org.apache.flink.cdc.common.event.RenameColumnEvent; +import org.apache.flink.cdc.common.event.SchemaChangeEvent; +import org.apache.flink.cdc.common.event.SchemaChangeEventType; +import org.apache.flink.cdc.common.event.TableId; +import org.apache.flink.cdc.common.event.TruncateTableEvent; +import org.apache.flink.cdc.common.event.visitor.SchemaChangeEventVisitor; +import org.apache.flink.cdc.common.exceptions.SchemaEvolveException; +import org.apache.flink.cdc.common.exceptions.UnsupportedSchemaChangeEventException; +import org.apache.flink.cdc.common.schema.Schema; +import org.apache.flink.cdc.common.sink.MetadataApplier; +import org.apache.flink.cdc.common.types.utils.DataTypeUtils; +import org.apache.flink.shaded.guava31.com.google.common.collect.Sets; +import org.apache.flink.table.factories.FactoryUtil; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import java.util.ArrayList; +import java.util.HashMap; +import java.util.List; +import java.util.Map; +import java.util.Set; + +import static org.apache.flink.cdc.common.utils.Preconditions.checkArgument; +import static org.apache.flink.cdc.common.utils.Preconditions.checkNotNull; + +/** A {@code MetadataApplier} that applies schema changes to Paimon table. */ +public class PaimonMetadataApplier implements MetadataApplier { + + private static final Logger LOG = LoggerFactory.getLogger(PaimonMetadataApplier.class); + + // Catalog is unSerializable. + private transient Catalog catalog; + + // currently, we set table options for all tables using the same options. + private final Map<String, String> tableOptions; + + private final Options catalogOptions; + + private final Map<TableId, List<String>> partitionMaps; + + private Set<SchemaChangeEventType> enabledSchemaEvolutionTypes; + + public PaimonMetadataApplier(Options catalogOptions) { + this.catalogOptions = catalogOptions; + this.tableOptions = new HashMap<>(); + this.partitionMaps = new HashMap<>(); + this.enabledSchemaEvolutionTypes = getSupportedSchemaEvolutionTypes(); + } + + public PaimonMetadataApplier( + Options catalogOptions, + Map<String, String> tableOptions, + Map<TableId, List<String>> partitionMaps) { + this.catalogOptions = catalogOptions; + this.tableOptions = tableOptions; + this.partitionMaps = partitionMaps; + this.enabledSchemaEvolutionTypes = getSupportedSchemaEvolutionTypes(); + } + + @Override + public MetadataApplier setAcceptedSchemaEvolutionTypes( + Set<SchemaChangeEventType> schemaEvolutionTypes) { + this.enabledSchemaEvolutionTypes = schemaEvolutionTypes; + return this; + } + + @Override + public boolean acceptsSchemaEvolutionType(SchemaChangeEventType schemaChangeEventType) { + return enabledSchemaEvolutionTypes.contains(schemaChangeEventType); + } + + @Override + public Set<SchemaChangeEventType> getSupportedSchemaEvolutionTypes() { + return Sets.newHashSet( + SchemaChangeEventType.CREATE_TABLE, + SchemaChangeEventType.ADD_COLUMN, + SchemaChangeEventType.DROP_COLUMN, + SchemaChangeEventType.RENAME_COLUMN, + SchemaChangeEventType.ALTER_COLUMN_TYPE); + } + + @Override + public void applySchemaChange(SchemaChangeEvent schemaChangeEvent) + throws SchemaEvolveException { + if (catalog == null) { + FlinkCatalogFactory flinkCatalogFactory = + FactoryUtil.discoverFactory( + FlinkCatalogFactory.class.getClassLoader(), + FlinkCatalogFactory.class, + FlinkCatalogFactory.IDENTIFIER); + FlinkCatalog flinkCatalog = + flinkCatalogFactory.createCatalog( + new FactoryUtil.DefaultCatalogContext( + "flink-catalog", + catalogOptions.toMap(), + null, + FlinkCatalog.class.getClassLoader())); + catalog = flinkCatalog.catalog(); + } + SchemaChangeEventVisitor.visit( + schemaChangeEvent, + addColumnEvent -> { + applyAddColumn(addColumnEvent); + return null; + }, + alterColumnTypeEvent -> { + applyAlterColumnType(alterColumnTypeEvent); + return null; + }, + createTableEvent -> { + applyCreateTable(createTableEvent); + return null; + }, + dropColumnEvent -> { + applyDropColumn(dropColumnEvent); + return null; + }, + dropTableEvent -> { + applyDropTable(dropTableEvent); + return null; + }, + renameColumnEvent -> { + applyRenameColumn(renameColumnEvent); + return null; + }, + truncateTableEvent -> { + applyTruncateTable(truncateTableEvent); + return null; + }); + } + + @Override + public void close() throws Exception { + if (catalog != null) { + catalog.close(); + } + } + + private void applyCreateTable(CreateTableEvent event) throws SchemaEvolveException { + try { + if (!catalog.listDatabases().contains(event.tableId().getSchemaName())) { + catalog.createDatabase(event.tableId().getSchemaName(), true); + } + Schema schema = event.getSchema(); + org.apache.paimon.schema.Schema.Builder builder = + new org.apache.paimon.schema.Schema.Builder(); + schema.getColumns() + .forEach( + (column) -> + builder.column( + column.getName(), + LogicalTypeConversion.toDataType( + DataTypeUtils.toFlinkDataType(column.getType()) + .getLogicalType()), + column.getComment())); + List<String> partitionKeys = new ArrayList<>(); + List<String> primaryKeys = schema.primaryKeys(); + if (partitionMaps.containsKey(event.tableId())) { + partitionKeys.addAll(partitionMaps.get(event.tableId())); + } else if (schema.partitionKeys() != null && !schema.partitionKeys().isEmpty()) { + partitionKeys.addAll(schema.partitionKeys()); + } + for (String partitionColumn : partitionKeys) { + if (!primaryKeys.contains(partitionColumn)) { + primaryKeys.add(partitionColumn); + } + } + builder.primaryKey(primaryKeys) + .partitionKeys(partitionKeys) + .comment(schema.comment()) + .options(tableOptions) + .options(schema.options()); + catalog.createTable(tableIdToIdentifier(event), builder.build(), true); + } catch (Catalog.TableAlreadyExistException + | Catalog.DatabaseNotExistException + | Catalog.DatabaseAlreadyExistException e) { + throw new SchemaEvolveException(event, e.getMessage(), e); + } + } + + private void applyAddColumn(AddColumnEvent event) throws SchemaEvolveException { + try { + List<SchemaChange> tableChangeList = applyAddColumnEventWithPosition(event); + catalog.alterTable(tableIdToIdentifier(event), tableChangeList, true); + } catch (Catalog.TableNotExistException + | Catalog.ColumnAlreadyExistException + | Catalog.ColumnNotExistException e) { + if (e instanceof Catalog.ColumnAlreadyExistException) { + LOG.warn("{}, skip it.", e.getMessage()); + } else { + throw new SchemaEvolveException(event, e.getMessage(), e); + } + } + } + + private List<SchemaChange> applyAddColumnEventWithPosition(AddColumnEvent event) + throws SchemaEvolveException { + try { + List<SchemaChange> tableChangeList = new ArrayList<>(); + for (AddColumnEvent.ColumnWithPosition columnWithPosition : event.getAddedColumns()) { + switch (columnWithPosition.getPosition()) { + case FIRST: + tableChangeList.addAll( + SchemaChangeProvider.add( + columnWithPosition, + SchemaChange.Move.first( + columnWithPosition.getAddColumn().getName()))); + break; + case LAST: + tableChangeList.addAll(SchemaChangeProvider.add(columnWithPosition)); + break; + case BEFORE: + tableChangeList.addAll( + applyAddColumnWithBeforePosition( + event.tableId().getSchemaName(), + event.tableId().getTableName(), + columnWithPosition)); + break; + case AFTER: + checkNotNull( + columnWithPosition.getExistedColumnName(), + "Existing column name must be provided for AFTER position"); + SchemaChange.Move after = + SchemaChange.Move.after( + columnWithPosition.getAddColumn().getName(), + columnWithPosition.getExistedColumnName()); + tableChangeList.addAll(SchemaChangeProvider.add(columnWithPosition, after)); + break; + default: + throw new SchemaEvolveException( + event, + "Unknown column position: " + columnWithPosition.getPosition()); + } + } + return tableChangeList; + } catch (Catalog.TableNotExistException e) { + throw new SchemaEvolveException(event, e.getMessage(), e); + } + } + + private List<SchemaChange> applyAddColumnWithBeforePosition( + String schemaName, + String tableName, + AddColumnEvent.ColumnWithPosition columnWithPosition) + throws Catalog.TableNotExistException { + String existedColumnName = columnWithPosition.getExistedColumnName(); + Table table = catalog.getTable(new Identifier(schemaName, tableName)); + List<String> columnNames = table.rowType().getFieldNames(); + int index = checkColumnPosition(existedColumnName, columnNames); + String columnName = columnWithPosition.getAddColumn().getName(); + return SchemaChangeProvider.add( + columnWithPosition, + (index == 0) + ? SchemaChange.Move.first(columnName) + : SchemaChange.Move.after(columnName, columnNames.get(index - 1))); + } + + private int checkColumnPosition(String existedColumnName, List<String> columnNames) { + if (existedColumnName == null) { + return 0; + } + int index = columnNames.indexOf(existedColumnName); + checkArgument(index != -1, "Column %s not found", existedColumnName); + return index; + } + + private void applyDropColumn(DropColumnEvent event) throws SchemaEvolveException { + try { + List<SchemaChange> tableChangeList = new ArrayList<>(); + event.getDroppedColumnNames() + .forEach((column) -> tableChangeList.addAll(SchemaChangeProvider.drop(column))); + catalog.alterTable(tableIdToIdentifier(event), tableChangeList, true); + } catch (Catalog.TableNotExistException | Catalog.ColumnNotExistException e) { + LOG.warn("Failed to apply DropColumnEvent, skip it.", e); + } catch (Catalog.ColumnAlreadyExistException e) { + throw new SchemaEvolveException(event, e.getMessage(), e); + } + } + + private void applyRenameColumn(RenameColumnEvent event) throws SchemaEvolveException { + try { + Map<String, String> options = Review Comment: unused variable. ########## paimon-flink/paimon-flink-cdc/src/test/java/org/apache/paimon/flink/pipeline/cdc/schema/PaimonMetadataApplierTest.java: ########## @@ -0,0 +1,609 @@ +/* + * 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.paimon.flink.pipeline.cdc.schema; + +import org.apache.paimon.CoreOptions; +import org.apache.paimon.catalog.Catalog; +import org.apache.paimon.catalog.FileSystemCatalogFactory; +import org.apache.paimon.catalog.Identifier; +import org.apache.paimon.flink.FlinkCatalogFactory; +import org.apache.paimon.flink.pipeline.cdc.util.FlinkCDCToPaimonTypeConverter; +import org.apache.paimon.options.CatalogOptions; +import org.apache.paimon.options.Options; +import org.apache.paimon.table.Table; +import org.apache.paimon.types.DataField; +import org.apache.paimon.types.DataTypes; +import org.apache.paimon.types.RowType; + +import org.apache.flink.cdc.common.event.AddColumnEvent; +import org.apache.flink.cdc.common.event.AlterColumnTypeEvent; +import org.apache.flink.cdc.common.event.CreateTableEvent; +import org.apache.flink.cdc.common.event.DropColumnEvent; +import org.apache.flink.cdc.common.event.RenameColumnEvent; +import org.apache.flink.cdc.common.event.TableId; +import org.apache.flink.cdc.common.exceptions.SchemaEvolveException; +import org.apache.flink.cdc.common.schema.Column; +import org.apache.flink.cdc.common.sink.MetadataApplier; +import org.apache.flink.cdc.common.types.DataType; +import org.assertj.core.api.Assertions; +import org.junit.jupiter.api.AfterAll; +import org.junit.jupiter.api.BeforeAll; +import org.junit.jupiter.api.Test; +import org.junit.jupiter.api.io.TempDir; + +import java.io.File; +import java.util.ArrayList; +import java.util.Arrays; +import java.util.Collections; +import java.util.HashMap; +import java.util.List; +import java.util.Map; +import java.util.UUID; + +/** Tests for {@link PaimonMetadataApplier}. */ +class PaimonMetadataApplierTest { + + @TempDir public static java.nio.file.Path temporaryFolder; + + private static Catalog catalog; + + private static Options catalogOptions; + + private static MetadataApplier metadataApplier; + + @BeforeAll + public static void initialize() { + catalogOptions = new Options(); + catalogOptions.setString( + CatalogOptions.METASTORE.key(), FileSystemCatalogFactory.IDENTIFIER); + catalogOptions.setString( + CatalogOptions.WAREHOUSE.key(), + new File(temporaryFolder.toFile(), UUID.randomUUID().toString()).toString()); + catalogOptions.set(CatalogOptions.CACHE_ENABLED.key(), "false"); + catalog = FlinkCatalogFactory.createPaimonCatalog(catalogOptions); + + Map<String, String> tableOptions = new HashMap<>(); + tableOptions.put(CoreOptions.BUCKET.key(), "-1"); + metadataApplier = new PaimonMetadataApplier(catalogOptions, tableOptions, new HashMap<>()); + } + + @AfterAll + public static void close() throws Exception { + if (catalog != null) { + catalog.close(); + } + metadataApplier.close(); Review Comment: also check whether metadataApplier is null. -- 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: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
