rajarshisarkar commented on code in PR #4539: URL: https://github.com/apache/iceberg/pull/4539#discussion_r849246057
########## spark/v3.2/spark/src/main/java/org/apache/iceberg/spark/actions/BaseCdcSparkAction.java: ########## @@ -0,0 +1,262 @@ +/* + * 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.spark.actions; + +import java.util.List; +import java.util.Set; +import java.util.UUID; +import java.util.stream.Collectors; +import org.apache.iceberg.BaseFileScanTask; +import org.apache.iceberg.DataFile; +import org.apache.iceberg.DataOperations; +import org.apache.iceberg.FileContent; +import org.apache.iceberg.FileScanTask; +import org.apache.iceberg.HasTableOperations; +import org.apache.iceberg.ManifestFile; +import org.apache.iceberg.ManifestGroup; +import org.apache.iceberg.MetadataColumns; +import org.apache.iceberg.Snapshot; +import org.apache.iceberg.Table; +import org.apache.iceberg.actions.Cdc; +import org.apache.iceberg.expressions.Expression; +import org.apache.iceberg.expressions.Expressions; +import org.apache.iceberg.io.CloseableIterable; +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.Lists; +import org.apache.iceberg.relocated.com.google.common.collect.Sets; +import org.apache.iceberg.spark.FileScanTaskSetManager; +import org.apache.iceberg.spark.SparkReadOptions; +import org.apache.iceberg.util.SnapshotUtil; +import org.apache.spark.sql.Dataset; +import org.apache.spark.sql.Row; +import org.apache.spark.sql.SparkSession; +import org.apache.spark.sql.functions; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import static org.apache.spark.sql.functions.lit; + +public class BaseCdcSparkAction extends BaseSparkAction<Cdc, Cdc.Result> implements Cdc { + private static final Logger LOG = LoggerFactory.getLogger(BaseCdcSparkAction.class); + public static final String RECORD_TYPE = "_record_type"; + public static final String COMMIT_SNAPSHOT_ID = "_commit_snapshot_id"; + public static final String COMMIT_TIMESTAMP = "_commit_timestamp"; + public static final String COMMIT_ORDER = "_commit_order"; + private final List<Long> snapshotIds = Lists.newLinkedList(); + private final Table table; + private final List<Dataset<Row>> dfs = Lists.newLinkedList(); + private boolean ignoreRowsDeletedWithinSnapshot = true; + + private Expression filter = Expressions.alwaysTrue(); + + protected BaseCdcSparkAction(SparkSession spark, Table table) { + super(spark); + this.table = table; + } + + @Override + public Result execute() { + // use the current snapshot by default + if (snapshotIds.isEmpty()) { + if (table.currentSnapshot() != null) { + snapshotIds.add(table.currentSnapshot().snapshotId()); + } + } + + for (int i = 0; i < snapshotIds.size(); i++) { + generateCdcRecordsPerSnapshot(snapshotIds.get(i), i); + } + + Dataset<Row> outputDf = null; + for (Dataset<Row> df : dfs) { + if (outputDf == null) { + outputDf = df; + } else { + outputDf = outputDf.unionByName(df, true); + } + } + return new BaseCdcSparkActionResult(outputDf); + } + + private void generateCdcRecordsPerSnapshot(long snapshotId, int commitOrder) { + Snapshot snapshot = table.snapshot(snapshotId); + if (snapshot.operation().equals(DataOperations.REPLACE)) { + return; + } + + // new data file as the insert + Dataset<Row> df = readAppendDataFiles(snapshotId, commitOrder); + if (df != null) { + dfs.add(df); + } + + // metadata deleted data files + Dataset<Row> deletedDf = readMetadataDeletedFiles(snapshotId, commitOrder); + if (deletedDf != null) { + dfs.add(deletedDf); + } + + // pos and eq deletes + Dataset<Row> rowLevelDeleteDf = readRowLevelDeletes(snapshotId, commitOrder); + if (rowLevelDeleteDf != null) { + dfs.add(rowLevelDeleteDf); + } + } + + private Dataset<Row> readAppendDataFiles(long snapshotId, int commitOrder) { + List<FileScanTask> appendedFileTasks = planAppendedFiles(snapshotId); + if (appendedFileTasks.size() <= 0) { Review Comment: Let's use `appendedFileTasks.isEmpty()` ########## arrow/src/main/java/org/apache/iceberg/arrow/vectorized/VectorHolder.java: ########## @@ -146,4 +150,17 @@ public PositionVectorHolder(FieldVector vector, Type type, NullabilityHolder nul } } + public static class DeletedVectorHolder extends VectorHolder { + private final int numRows; + + public DeletedVectorHolder(int numRows) { + this.numRows = numRows; + } + + @Override + public int numValues() { + return this.numRows; Review Comment: I think the practice in Iceberg is to only use `this` when actually mutating the field, not needed when reading. ########## api/src/main/java/org/apache/iceberg/actions/ActionsProvider.java: ########## @@ -74,4 +74,11 @@ default ExpireSnapshots expireSnapshots(Table table) { default DeleteReachableFiles deleteReachableFiles(String metadataLocation) { throw new UnsupportedOperationException(this.getClass().getName() + " does not implement deleteReachableFiles"); } + + /** + * Instantiates an action to generate CDC records. + */ + default Cdc generateCdcRecords(Table table) { Review Comment: I feel we should not use acronyms. ########## arrow/src/main/java/org/apache/iceberg/arrow/vectorized/VectorizedArrowReader.java: ########## @@ -517,5 +517,32 @@ public void setBatchSize(int batchSize) { } } + /** + * A Dummy Vector Reader which doesn't actually read files, instead it returns a dummy + * VectorHolder which indicates whether the row is deleted. + */ + public static class DeletedVectorReader<T> extends VectorizedArrowReader { Review Comment: Do we plan on using this type parameter `T`? Currently it's unused. ########## spark/v3.2/spark/src/main/java/org/apache/iceberg/spark/actions/BaseCdcSparkAction.java: ########## @@ -0,0 +1,262 @@ +/* + * 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.spark.actions; + +import java.util.List; +import java.util.Set; +import java.util.UUID; +import java.util.stream.Collectors; +import org.apache.iceberg.BaseFileScanTask; +import org.apache.iceberg.DataFile; +import org.apache.iceberg.DataOperations; +import org.apache.iceberg.FileContent; +import org.apache.iceberg.FileScanTask; +import org.apache.iceberg.HasTableOperations; +import org.apache.iceberg.ManifestFile; +import org.apache.iceberg.ManifestGroup; +import org.apache.iceberg.MetadataColumns; +import org.apache.iceberg.Snapshot; +import org.apache.iceberg.Table; +import org.apache.iceberg.actions.Cdc; +import org.apache.iceberg.expressions.Expression; +import org.apache.iceberg.expressions.Expressions; +import org.apache.iceberg.io.CloseableIterable; +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.Lists; +import org.apache.iceberg.relocated.com.google.common.collect.Sets; +import org.apache.iceberg.spark.FileScanTaskSetManager; +import org.apache.iceberg.spark.SparkReadOptions; +import org.apache.iceberg.util.SnapshotUtil; +import org.apache.spark.sql.Dataset; +import org.apache.spark.sql.Row; +import org.apache.spark.sql.SparkSession; +import org.apache.spark.sql.functions; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import static org.apache.spark.sql.functions.lit; + +public class BaseCdcSparkAction extends BaseSparkAction<Cdc, Cdc.Result> implements Cdc { + private static final Logger LOG = LoggerFactory.getLogger(BaseCdcSparkAction.class); + public static final String RECORD_TYPE = "_record_type"; + public static final String COMMIT_SNAPSHOT_ID = "_commit_snapshot_id"; + public static final String COMMIT_TIMESTAMP = "_commit_timestamp"; + public static final String COMMIT_ORDER = "_commit_order"; + private final List<Long> snapshotIds = Lists.newLinkedList(); + private final Table table; + private final List<Dataset<Row>> dfs = Lists.newLinkedList(); + private boolean ignoreRowsDeletedWithinSnapshot = true; + + private Expression filter = Expressions.alwaysTrue(); + + protected BaseCdcSparkAction(SparkSession spark, Table table) { + super(spark); + this.table = table; + } + + @Override + public Result execute() { + // use the current snapshot by default + if (snapshotIds.isEmpty()) { + if (table.currentSnapshot() != null) { + snapshotIds.add(table.currentSnapshot().snapshotId()); + } + } + + for (int i = 0; i < snapshotIds.size(); i++) { + generateCdcRecordsPerSnapshot(snapshotIds.get(i), i); + } + + Dataset<Row> outputDf = null; + for (Dataset<Row> df : dfs) { + if (outputDf == null) { + outputDf = df; + } else { + outputDf = outputDf.unionByName(df, true); + } + } + return new BaseCdcSparkActionResult(outputDf); + } + + private void generateCdcRecordsPerSnapshot(long snapshotId, int commitOrder) { + Snapshot snapshot = table.snapshot(snapshotId); + if (snapshot.operation().equals(DataOperations.REPLACE)) { + return; + } + + // new data file as the insert + Dataset<Row> df = readAppendDataFiles(snapshotId, commitOrder); + if (df != null) { + dfs.add(df); + } + + // metadata deleted data files + Dataset<Row> deletedDf = readMetadataDeletedFiles(snapshotId, commitOrder); + if (deletedDf != null) { + dfs.add(deletedDf); + } + + // pos and eq deletes + Dataset<Row> rowLevelDeleteDf = readRowLevelDeletes(snapshotId, commitOrder); + if (rowLevelDeleteDf != null) { + dfs.add(rowLevelDeleteDf); + } + } + + private Dataset<Row> readAppendDataFiles(long snapshotId, int commitOrder) { + List<FileScanTask> appendedFileTasks = planAppendedFiles(snapshotId); + if (appendedFileTasks.size() <= 0) { + return null; + } + + String groupID = UUID.randomUUID().toString(); + FileScanTaskSetManager manager = FileScanTaskSetManager.get(); + manager.stageTasks(table, groupID, appendedFileTasks); + Dataset<Row> scanDF = spark().read().format("iceberg") + .option(SparkReadOptions.FILE_SCAN_TASK_SET_ID, groupID) + .load(table.name()); + + return withCdcColumns(scanDF, snapshotId, "I", commitOrder); + } + + private List<FileScanTask> planAppendedFiles(long snapshotId) { + CloseableIterable<FileScanTask> fileScanTasks = table.newScan() + .useSnapshot(snapshotId) + .filter(filter) + .ignoreResiduals() + .planFiles(); + + Set<CharSequence> dataFiles = Sets.newHashSet(); + for (DataFile dataFile : table.snapshot(snapshotId).addedFiles()) { + dataFiles.add(dataFile.path()); + } + + List<FileScanTask> appendedFiles = Lists.newLinkedList(); + if (dataFiles.size() <= 0) { Review Comment: Let's use `dataFiles.isEmpty()` ########## spark/v3.2/spark/src/main/java/org/apache/iceberg/spark/actions/BaseCdcSparkAction.java: ########## @@ -0,0 +1,262 @@ +/* + * 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.spark.actions; + +import java.util.List; +import java.util.Set; +import java.util.UUID; +import java.util.stream.Collectors; +import org.apache.iceberg.BaseFileScanTask; +import org.apache.iceberg.DataFile; +import org.apache.iceberg.DataOperations; +import org.apache.iceberg.FileContent; +import org.apache.iceberg.FileScanTask; +import org.apache.iceberg.HasTableOperations; +import org.apache.iceberg.ManifestFile; +import org.apache.iceberg.ManifestGroup; +import org.apache.iceberg.MetadataColumns; +import org.apache.iceberg.Snapshot; +import org.apache.iceberg.Table; +import org.apache.iceberg.actions.Cdc; +import org.apache.iceberg.expressions.Expression; +import org.apache.iceberg.expressions.Expressions; +import org.apache.iceberg.io.CloseableIterable; +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.Lists; +import org.apache.iceberg.relocated.com.google.common.collect.Sets; +import org.apache.iceberg.spark.FileScanTaskSetManager; +import org.apache.iceberg.spark.SparkReadOptions; +import org.apache.iceberg.util.SnapshotUtil; +import org.apache.spark.sql.Dataset; +import org.apache.spark.sql.Row; +import org.apache.spark.sql.SparkSession; +import org.apache.spark.sql.functions; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import static org.apache.spark.sql.functions.lit; + +public class BaseCdcSparkAction extends BaseSparkAction<Cdc, Cdc.Result> implements Cdc { + private static final Logger LOG = LoggerFactory.getLogger(BaseCdcSparkAction.class); + public static final String RECORD_TYPE = "_record_type"; + public static final String COMMIT_SNAPSHOT_ID = "_commit_snapshot_id"; + public static final String COMMIT_TIMESTAMP = "_commit_timestamp"; + public static final String COMMIT_ORDER = "_commit_order"; + private final List<Long> snapshotIds = Lists.newLinkedList(); + private final Table table; + private final List<Dataset<Row>> dfs = Lists.newLinkedList(); + private boolean ignoreRowsDeletedWithinSnapshot = true; + + private Expression filter = Expressions.alwaysTrue(); + + protected BaseCdcSparkAction(SparkSession spark, Table table) { + super(spark); + this.table = table; + } + + @Override + public Result execute() { + // use the current snapshot by default + if (snapshotIds.isEmpty()) { + if (table.currentSnapshot() != null) { + snapshotIds.add(table.currentSnapshot().snapshotId()); + } + } + + for (int i = 0; i < snapshotIds.size(); i++) { + generateCdcRecordsPerSnapshot(snapshotIds.get(i), i); + } + + Dataset<Row> outputDf = null; + for (Dataset<Row> df : dfs) { + if (outputDf == null) { + outputDf = df; + } else { + outputDf = outputDf.unionByName(df, true); + } + } + return new BaseCdcSparkActionResult(outputDf); + } + + private void generateCdcRecordsPerSnapshot(long snapshotId, int commitOrder) { + Snapshot snapshot = table.snapshot(snapshotId); + if (snapshot.operation().equals(DataOperations.REPLACE)) { + return; + } + + // new data file as the insert + Dataset<Row> df = readAppendDataFiles(snapshotId, commitOrder); + if (df != null) { + dfs.add(df); + } + + // metadata deleted data files + Dataset<Row> deletedDf = readMetadataDeletedFiles(snapshotId, commitOrder); + if (deletedDf != null) { + dfs.add(deletedDf); + } + + // pos and eq deletes + Dataset<Row> rowLevelDeleteDf = readRowLevelDeletes(snapshotId, commitOrder); + if (rowLevelDeleteDf != null) { + dfs.add(rowLevelDeleteDf); + } + } + + private Dataset<Row> readAppendDataFiles(long snapshotId, int commitOrder) { + List<FileScanTask> appendedFileTasks = planAppendedFiles(snapshotId); + if (appendedFileTasks.size() <= 0) { + return null; + } + + String groupID = UUID.randomUUID().toString(); + FileScanTaskSetManager manager = FileScanTaskSetManager.get(); + manager.stageTasks(table, groupID, appendedFileTasks); + Dataset<Row> scanDF = spark().read().format("iceberg") + .option(SparkReadOptions.FILE_SCAN_TASK_SET_ID, groupID) + .load(table.name()); + + return withCdcColumns(scanDF, snapshotId, "I", commitOrder); + } + + private List<FileScanTask> planAppendedFiles(long snapshotId) { + CloseableIterable<FileScanTask> fileScanTasks = table.newScan() + .useSnapshot(snapshotId) + .filter(filter) + .ignoreResiduals() + .planFiles(); + + Set<CharSequence> dataFiles = Sets.newHashSet(); + for (DataFile dataFile : table.snapshot(snapshotId).addedFiles()) { + dataFiles.add(dataFile.path()); + } + + List<FileScanTask> appendedFiles = Lists.newLinkedList(); + if (dataFiles.size() <= 0) { + return appendedFiles; + } + + fileScanTasks.forEach(fileScanTask -> { + if (fileScanTask.file().content().equals(FileContent.DATA) && dataFiles.contains(fileScanTask.file().path())) { + FileScanTask newFileScanTask = fileScanTask; + if (!ignoreRowsDeletedWithinSnapshot) { + // remove delete files so that no delete will apply to the data file + Preconditions.checkArgument(fileScanTask instanceof BaseFileScanTask, + "Object fileScanTask should be an instance of BaseFileScanTask"); + newFileScanTask = ((BaseFileScanTask) fileScanTask).cloneWithoutDeletes(); + } + appendedFiles.add(newFileScanTask); + } + }); + + return appendedFiles; + } + + private Dataset<Row> readMetadataDeletedFiles(long snapshotId, int commitOrder) { + List<FileScanTask> appendedFileTasks = planMetadataDeletedFiles(snapshotId); + if (appendedFileTasks.size() <= 0) { + return null; + } + + String groupID = UUID.randomUUID().toString(); + FileScanTaskSetManager manager = FileScanTaskSetManager.get(); + manager.stageTasks(table, groupID, appendedFileTasks); + Dataset<Row> scanDF = spark().read().format("iceberg") + .option(SparkReadOptions.FILE_SCAN_TASK_SET_ID, groupID) + .load(table.name()); + + return withCdcColumns(scanDF, snapshotId, "D", commitOrder); + } + + private List<FileScanTask> planMetadataDeletedFiles(long snapshotId) { + Snapshot snapshot = table.snapshot(snapshotId); + ManifestGroup manifestGroup = new ManifestGroup(table.io(), snapshot.dataManifests(), snapshot.deleteManifests()) + .filterData(filter) + .ignoreAdded() + .specsById(((HasTableOperations) table).operations().current().specsById()); + + return ImmutableList.copyOf(manifestGroup.planFiles()); + } + + private Dataset<Row> readRowLevelDeletes(long snapshotId, int commitOrder) { + List<FileScanTask> fileScanTasks = planRowLevelDeleteFiles(snapshotId); + if (fileScanTasks.size() <= 0) { + return null; + } + + String groupID = UUID.randomUUID().toString(); + FileScanTaskSetManager manager = FileScanTaskSetManager.get(); + manager.stageTasks(table, groupID, fileScanTasks); + Dataset<Row> scanDF = spark().read().format("iceberg") + .option(SparkReadOptions.FILE_SCAN_TASK_SET_ID, groupID) + .load(table.name()) + .filter(functions.column(MetadataColumns.IS_DELETED.name()).equalTo(true)); + + return withCdcColumns(scanDF, snapshotId, "D", commitOrder); + } + + private List<FileScanTask> planRowLevelDeleteFiles(long snapshotId) { + Snapshot snapshot = table.snapshot(snapshotId); + List<ManifestFile> manifestFiles = snapshot.deleteManifests().stream() + .filter(manifestFile -> manifestFile.snapshotId().equals(snapshotId)) + .collect(Collectors.toList()); + + // todo create a partition filter to filter out unrelated partitions + ManifestGroup manifestGroup = new ManifestGroup(table.io(), snapshot.dataManifests(), manifestFiles) + .filterData(filter) + .onlyWithDeletes() + .specsById(((HasTableOperations) table).operations().current().specsById()); + + return ImmutableList.copyOf(manifestGroup.planFiles()); + } + + private Dataset<Row> withCdcColumns(Dataset<Row> df, long snapshotId, String cdcType, int commitOrder) { + return df.withColumn(RECORD_TYPE, lit(cdcType)) + .withColumn(COMMIT_SNAPSHOT_ID, lit(snapshotId)) + .withColumn(COMMIT_TIMESTAMP, lit(table.snapshot(snapshotId).timestampMillis())) + .withColumn(COMMIT_ORDER, lit(commitOrder)); + } + + @Override + public Cdc useSnapshot(long snapshotId) { + if (table.snapshot(snapshotId) != null) { + snapshotIds.add(snapshotId); + } + return this; + } + + @Override + public Cdc between(long fromSnapshotId, long toSnapshotId) { + Preconditions.checkArgument(table.snapshot(fromSnapshotId) != null, + "The fromSnapshotId(%s) is invalid", fromSnapshotId); + Preconditions.checkArgument(table.snapshot(toSnapshotId) != null, Review Comment: We should also check if `fromSnapshotId` is an ancestor of `toSnapshotId`: ``` Preconditions.checkArgument(SnapshotUtil.isAncestorOf(table, toSnapshotId, fromSnapshotId), "from snapshot %s is not an ancestor of to snapshot %s", fromSnapshotId, toSnapshotId); ``` -- 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] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
