openinx commented on a change in pull request #1185: URL: https://github.com/apache/iceberg/pull/1185#discussion_r473892173
########## File path: flink/src/main/java/org/apache/iceberg/flink/IcebergFilesCommitter.java ########## @@ -0,0 +1,217 @@ +/* + * 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.iceberg.flink; + +import java.util.Comparator; +import java.util.List; +import java.util.Map; +import java.util.NavigableMap; +import java.util.SortedMap; +import org.apache.flink.api.common.state.ListState; +import org.apache.flink.api.common.state.ListStateDescriptor; +import org.apache.flink.api.common.typeinfo.BasicTypeInfo; +import org.apache.flink.api.common.typeinfo.TypeInformation; +import org.apache.flink.api.java.typeutils.ListTypeInfo; +import org.apache.flink.runtime.state.StateInitializationContext; +import org.apache.flink.runtime.state.StateSnapshotContext; +import org.apache.flink.streaming.api.operators.AbstractStreamOperator; +import org.apache.flink.streaming.api.operators.BoundedOneInput; +import org.apache.flink.streaming.api.operators.OneInputStreamOperator; +import org.apache.flink.streaming.runtime.streamrecord.StreamRecord; +import org.apache.flink.table.runtime.typeutils.SortedMapTypeInfo; +import org.apache.hadoop.conf.Configuration; +import org.apache.iceberg.AppendFiles; +import org.apache.iceberg.DataFile; +import org.apache.iceberg.Snapshot; +import org.apache.iceberg.Table; +import org.apache.iceberg.catalog.Catalog; +import org.apache.iceberg.catalog.TableIdentifier; +import org.apache.iceberg.hadoop.SerializableConfiguration; +import org.apache.iceberg.relocated.com.google.common.base.Preconditions; +import org.apache.iceberg.relocated.com.google.common.collect.ImmutableList; +import org.apache.iceberg.relocated.com.google.common.collect.ImmutableMap; +import org.apache.iceberg.relocated.com.google.common.collect.Lists; +import org.apache.iceberg.relocated.com.google.common.collect.Maps; +import org.apache.iceberg.types.Comparators; +import org.apache.iceberg.types.Types; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +class IcebergFilesCommitter extends AbstractStreamOperator<Void> + implements OneInputStreamOperator<DataFile, Void>, BoundedOneInput { + + private static final long serialVersionUID = 1L; + private static final long INITIAL_CHECKPOINT_ID = -1L; + + private static final Logger LOG = LoggerFactory.getLogger(IcebergFilesCommitter.class); + private static final String GLOBAL_FILES_COMMITTER_UID = "flink.files-committer.uid"; + private static final String MAX_COMMITTED_CHECKPOINT_ID = "flink.max-committed.checkpoint.id"; + + private static final FlinkCatalogFactory CATALOG_FACTORY = new FlinkCatalogFactory(); + + // It will have an unique identifier for one job. + private final String filesCommitterUid; + private final String fullTableName; + private final SerializableConfiguration conf; + private final ImmutableMap<String, String> options; + + // The max checkpoint id we've committed to iceberg table. As the flink's checkpoint is always increasing, so we could + // correctly commit all the data files whose checkpoint id is greater than the max committed one to iceberg table, for + // avoiding committing the same data files twice. This id will be attached to iceberg's meta when committing the + // iceberg transaction. + private transient long maxCommittedCheckpointId; + + // A sorted map to maintain the completed data files for each pending checkpointId (which have not been committed + // to iceberg table). We need a sorted map here because there's possible that few checkpoints snapshot failed, for + // example: the 1st checkpoint have 2 data files <1, <file0, file1>>, the 2st checkpoint have 1 data files + // <2, <file3>>. Snapshot for checkpoint#1 interrupted because of network/disk failure etc, while we don't expect + // any data loss in iceberg table. So we keep the finished files <1, <file0, file1>> in memory and retry to commit + // iceberg table when the next checkpoint happen. + private final NavigableMap<Long, List<DataFile>> dataFilesPerCheckpoint = Maps.newTreeMap(); + + // The data files cache for current checkpoint. Once the snapshot barrier received, it will be flushed to the + // 'dataFilesPerCheckpoint'. + private final List<DataFile> dataFilesOfCurrentCheckpoint = Lists.newArrayList(); + private transient Table table; + + // All pending checkpoints states for this function. + private static final ListStateDescriptor<SortedMap<Long, List<DataFile>>> STATE_DESCRIPTOR = buildStateDescriptor(); + + private transient ListState<SortedMap<Long, List<DataFile>>> checkpointsState; + + IcebergFilesCommitter(String filesCommitterUid, String fullTableName, + Map<String, String> options, Configuration conf) { + this.filesCommitterUid = filesCommitterUid; + this.fullTableName = fullTableName; + this.options = ImmutableMap.copyOf(options); + this.conf = new SerializableConfiguration(conf); + } + + @Override + public void initializeState(StateInitializationContext context) throws Exception { + super.initializeState(context); + Catalog icebergCatalog = CATALOG_FACTORY.buildIcebergCatalog(fullTableName, options, conf.get()); + + table = icebergCatalog.loadTable(TableIdentifier.parse(fullTableName)); + maxCommittedCheckpointId = INITIAL_CHECKPOINT_ID; + + checkpointsState = context.getOperatorStateStore().getListState(STATE_DESCRIPTOR); + if (context.isRestored()) { + maxCommittedCheckpointId = getMaxCommittedCheckpointId(table, filesCommitterUid); + // In the restoring path, it should have one valid snapshot for current flink job at least, so the max committed + // checkpoint id should be positive. If it's not positive, that means someone might have removed or expired the + // iceberg snapshot, in that case we should throw an exception in case of committing duplicated data files into + // the iceberg table. + Preconditions.checkArgument(maxCommittedCheckpointId > 0, + "There should be an existing iceberg snapshot for current flink job: %s", filesCommitterUid); + + SortedMap<Long, List<DataFile>> restoredDataFiles = checkpointsState.get().iterator().next(); + // Only keep the uncommitted data files in the cache. + dataFilesPerCheckpoint.putAll(restoredDataFiles.tailMap(maxCommittedCheckpointId + 1)); + } + } + + @Override + public void snapshotState(StateSnapshotContext context) throws Exception { + super.snapshotState(context); + long checkpointId = context.getCheckpointId(); + LOG.info("Start to flush snapshot state to state backend, table: {}, checkpointId: {}", table, checkpointId); + + // Update the checkpoint state. + dataFilesPerCheckpoint.put(checkpointId, ImmutableList.copyOf(dataFilesOfCurrentCheckpoint)); + + // Reset the snapshot state to the latest state. + checkpointsState.clear(); + checkpointsState.addAll(ImmutableList.of(dataFilesPerCheckpoint)); + + // Clear the local buffer for current checkpoint. + dataFilesOfCurrentCheckpoint.clear(); + } + + @Override + public void notifyCheckpointComplete(long checkpointId) throws Exception { + super.notifyCheckpointComplete(checkpointId); + commitUpToCheckpoint(checkpointId); + } + + private void commitUpToCheckpoint(long checkpointId) { + NavigableMap<Long, List<DataFile>> pendingFileMap = dataFilesPerCheckpoint.headMap(checkpointId, true); + + List<DataFile> pendingDataFiles = Lists.newArrayList(); + for (List<DataFile> dataFiles : pendingFileMap.values()) { + pendingDataFiles.addAll(dataFiles); + } + + if (!pendingDataFiles.isEmpty()) { + AppendFiles appendFiles = table.newAppend(); + pendingDataFiles.forEach(appendFiles::appendFile); + appendFiles.set(MAX_COMMITTED_CHECKPOINT_ID, Long.toString(checkpointId)); + appendFiles.set(GLOBAL_FILES_COMMITTER_UID, filesCommitterUid); + appendFiles.commit(); Review comment: The `MAX_COMMITTED_CHECKPOINT_ID` stored in iceberg table is mainly used for avoiding duplicated data files to be committed to iceberg table. Now we're sure that there's no data files to commit, advancing the max-committed-checkpoint-id don't have much value in my thought. ---------------------------------------------------------------- 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. For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
