vamshikrishnakyatham commented on code in PR #13745: URL: https://github.com/apache/hudi/pull/13745#discussion_r2353551125
########## hudi-spark-datasource/hudi-spark/src/main/scala/org/apache/spark/sql/hudi/command/procedures/ShowFileHistoryProcedureUtils.scala: ########## @@ -0,0 +1,415 @@ +/* + * 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.spark.sql.hudi.command.procedures + +import org.apache.hudi.common.model.{HoodieCommitMetadata, HoodieWriteStat, WriteOperationType} +import org.apache.hudi.common.table.HoodieTableMetaClient +import org.apache.hudi.common.table.timeline.{HoodieInstant, HoodieTimeline} +import org.apache.hudi.common.util.ClusteringUtils + +import org.apache.spark.internal.Logging +import org.apache.spark.sql.types.{DataTypes, Metadata, StructField, StructType} + +import java.util + +import scala.collection.JavaConverters._ + +case class HistoryEntry(instantTime: String, + completionTime: String, + action: String, + timelineType: String, + state: String, + partitionPath: String, + fileName: String, + operationType: String, + numWrites: Long, + numInserts: Long, + numUpdates: Long, + numDeletes: Long, + fileSizeBytes: Long, + totalWriteBytes: Long, + prevCommit: String, + totalWriteErrors: Long, + totalScanTimeMs: Long, + totalUpsertTimeMs: Long, + totalCreateTimeMs: Long, + prevBaseFile: Option[String], + columnStatsAvailable: Boolean + ) + +case class DeletionInfo(action: String, instant: String, timelineType: String) + +case class ReplacementInfo(action: String, instant: String, timelineType: String) + +object ShowFileHistoryProcedureUtils extends Logging { + + val OUTPUT_TYPE = new StructType(Array[StructField]( + StructField("instant_time", DataTypes.StringType, nullable = true, Metadata.empty), + StructField("completion_time", DataTypes.StringType, nullable = true, Metadata.empty), + StructField("action", DataTypes.StringType, nullable = true, Metadata.empty), + StructField("timeline_type", DataTypes.StringType, nullable = true, Metadata.empty), + StructField("state", DataTypes.StringType, nullable = true, Metadata.empty), + StructField("partition_path", DataTypes.StringType, nullable = true, Metadata.empty), + StructField("file_name", DataTypes.StringType, nullable = true, Metadata.empty), + StructField("operation_type", DataTypes.StringType, nullable = true, Metadata.empty), + StructField("num_writes", DataTypes.LongType, nullable = true, Metadata.empty), + StructField("num_inserts", DataTypes.LongType, nullable = true, Metadata.empty), + StructField("num_updates", DataTypes.LongType, nullable = true, Metadata.empty), + StructField("num_deletes", DataTypes.LongType, nullable = true, Metadata.empty), + StructField("file_size_bytes", DataTypes.LongType, nullable = true, Metadata.empty), + StructField("total_write_bytes", DataTypes.LongType, nullable = true, Metadata.empty), + StructField("prev_commit", DataTypes.StringType, nullable = true, Metadata.empty), + StructField("was_deleted", DataTypes.BooleanType, nullable = true, Metadata.empty), + StructField("delete_action", DataTypes.StringType, nullable = true, Metadata.empty), + StructField("delete_instant", DataTypes.StringType, nullable = true, Metadata.empty), + StructField("was_replaced", DataTypes.BooleanType, nullable = true, Metadata.empty), + StructField("replace_action", DataTypes.StringType, nullable = true, Metadata.empty), + StructField("replace_instant", DataTypes.StringType, nullable = true, Metadata.empty), + StructField("total_write_errors", DataTypes.LongType, nullable = true, Metadata.empty), + StructField("total_scan_time_ms", DataTypes.LongType, nullable = true, Metadata.empty), + StructField("total_upsert_time_ms", DataTypes.LongType, nullable = true, Metadata.empty), + StructField("total_create_time_ms", DataTypes.LongType, nullable = true, Metadata.empty), + StructField("prev_base_file", DataTypes.StringType, nullable = true, Metadata.empty), + StructField("column_stats_available", DataTypes.BooleanType, nullable = true, Metadata.empty) + )) + + def readCommitMetadata(timeline: HoodieTimeline, instant: HoodieInstant): Option[HoodieCommitMetadata] = { + try { + if (ClusteringUtils.isClusteringOrReplaceCommitAction(instant.getAction)) { + Option(timeline.readReplaceCommitMetadata(instant)) + } else { + Option(timeline.readCommitMetadata(instant)) + } + } catch { + case e: Exception => + log.warn(s"Failed to read commit metadata for ${instant.requestedTime}: ${e.getMessage}") + None + } + } + + def determineOperationType(writeStat: HoodieWriteStat): String = { + if (writeStat.getNumInserts > 0 && writeStat.getNumUpdateWrites == 0) "INSERT" + else if (writeStat.getNumInserts == 0 && writeStat.getNumUpdateWrites > 0) "UPDATE" + else if (writeStat.getNumInserts > 0 && writeStat.getNumUpdateWrites > 0) "UPSERT" + else if (writeStat.getNumDeletes > 0) "DELETE" + else "UNKNOWN" + } + + def processTimeline(timeline: HoodieTimeline, + fileGroupId: String, + targetPartition: Option[String], + timelineType: String, + entries: util.ArrayList[HistoryEntry], + limit: Int, + startTime: String, + endTime: String): Unit = { + + val writeTimeline = timeline.getWriteTimeline + val instants = writeTimeline.getInstants.asScala.toSeq + .filter { instant => + val instantTime = instant.requestedTime() + val withinStartTime = if (startTime.nonEmpty) instantTime >= startTime else true + val withinEndTime = if (endTime.nonEmpty) instantTime <= endTime else true + withinStartTime && withinEndTime + } + val filteredInstants = instants.sortWith((a, b) => a.requestedTime() > b.requestedTime()) + + if (startTime.nonEmpty && endTime.nonEmpty) { + for (instant <- filteredInstants) { + try { + processInstant(timeline, instant, fileGroupId, targetPartition, timelineType, entries) + } catch { + case e: Exception => + log.warn(s"Failed to process instant ${instant.requestedTime}: ${e.getMessage}") + } + } + } else { + var foundCount = 0 + for (instant <- filteredInstants if foundCount < limit) { + try { + val initialSize = entries.size() + processInstant(timeline, instant, fileGroupId, targetPartition, timelineType, entries) + if (entries.size() > initialSize) { + foundCount += 1 + } + } catch { + case e: Exception => + log.warn(s"Failed to process instant ${instant.requestedTime}: ${e.getMessage}") + } + } + } + } + + private def processInstant(timeline: HoodieTimeline, + instant: HoodieInstant, + fileGroupId: String, + targetPartition: Option[String], + timelineType: String, + entries: util.ArrayList[HistoryEntry]): Unit = { + + if (instant.getState == HoodieInstant.State.INFLIGHT || instant.getState == HoodieInstant.State.REQUESTED) { + val entry = createInflightRequestedEntry(instant, targetPartition, timelineType) + entries.add(entry) + } + + val commitMetadata = readCommitMetadata(timeline, instant) + if (commitMetadata.isDefined) { + val metadata = commitMetadata.get + val partitionsToCheck = targetPartition.map(Set(_)).getOrElse(metadata.getPartitionToWriteStats.keySet().asScala.toSet) + + for (partitionPath <- partitionsToCheck) { + val writeStatsOpt = Option(metadata.getPartitionToWriteStats.get(partitionPath)) + if (writeStatsOpt.isDefined) { + val writeStats = writeStatsOpt.get.asScala + for (writeStat <- writeStats) { + if (writeStat.getFileId == fileGroupId) { + val entry = createHistoryEntry(instant, writeStat, partitionPath, timelineType) + entries.add(entry) + } + } + } + } + } + } + + def createHistoryEntry(instant: HoodieInstant, + writeStat: HoodieWriteStat, + targetPartition: String, + timelineType: String): HistoryEntry = { + + val fileName = Option(writeStat.getPath).map(_.split("/").last).getOrElse("") + val operationType = determineOperationType(writeStat) + + val runtimeStats = Option(writeStat.getRuntimeStats) + val scanTime = runtimeStats.map(_.getTotalScanTime).getOrElse(0L) + val upsertTime = runtimeStats.map(_.getTotalUpsertTime).getOrElse(0L) + val createTime = runtimeStats.map(_.getTotalCreateTime).getOrElse(0L) + + HistoryEntry( + instantTime = instant.requestedTime, + completionTime = instant.getCompletionTime, + action = instant.getAction, + timelineType = timelineType, + state = instant.getState.toString, + partitionPath = targetPartition, + fileName = fileName, + operationType = operationType, + numWrites = writeStat.getNumWrites, + numInserts = writeStat.getNumInserts, + numUpdates = writeStat.getNumUpdateWrites, + numDeletes = writeStat.getNumDeletes, + fileSizeBytes = writeStat.getFileSizeInBytes, + totalWriteBytes = writeStat.getTotalWriteBytes, + prevCommit = writeStat.getPrevCommit, + totalWriteErrors = writeStat.getTotalWriteErrors, + totalScanTimeMs = scanTime, + totalUpsertTimeMs = upsertTime, + totalCreateTimeMs = createTime, + prevBaseFile = Option(writeStat.getPrevBaseFile), + columnStatsAvailable = writeStat.getColumnStats.isPresent + ) + } + + def createInflightRequestedEntry(instant: HoodieInstant, + targetPartition: Option[String], + timelineType: String): HistoryEntry = { + + HistoryEntry( + instantTime = instant.requestedTime, + completionTime = instant.getCompletionTime, + action = instant.getAction, + timelineType = timelineType, + state = instant.getState.toString, + partitionPath = targetPartition.getOrElse(""), + fileName = "", + operationType = "UNKNOWN", + numWrites = -1, + numInserts = -1, + numUpdates = -1, + numDeletes = -1, + fileSizeBytes = -1, + totalWriteBytes = -1, + prevCommit = "", + totalWriteErrors = -1, + totalScanTimeMs = -1, + totalUpsertTimeMs = -1, + totalCreateTimeMs = -1, + prevBaseFile = None, + columnStatsAvailable = false + ) + } + + def checkForDeletionsAndReplacements(metaClient: HoodieTableMetaClient, + fileGroupId: String, + targetPartition: Option[String], + showArchived: Boolean): (Map[String, DeletionInfo], Map[String, ReplacementInfo]) = { + + val deletions = scala.collection.mutable.Map[String, DeletionInfo]() + val replacements = scala.collection.mutable.Map[String, ReplacementInfo]() + + checkDeletionsAndReplacementsInTimeline(metaClient.getActiveTimeline, fileGroupId, targetPartition, "ACTIVE", deletions, replacements) + + if (showArchived) { + try { + val archivedTimeline = metaClient.getArchivedTimeline.reload() + archivedTimeline.loadCompletedInstantDetailsInMemory() + checkDeletionsAndReplacementsInTimeline(archivedTimeline, fileGroupId, targetPartition, "ARCHIVED", deletions, replacements) + } catch { + case e: Exception => + log.warn(s"Failed to check deletions in archived timeline: ${e.getMessage}") + } + } + + (deletions.toMap, replacements.toMap) + } + + def checkDeletionsAndReplacementsInTimeline(timeline: HoodieTimeline, + fileGroupId: String, + targetPartition: Option[String], + timelineType: String, + deletions: scala.collection.mutable.Map[String, DeletionInfo], + replacements: scala.collection.mutable.Map[String, ReplacementInfo]): Unit = { + + val cleanInstants = timeline.getCleanerTimeline.getInstants.iterator().asScala + for (instant <- cleanInstants) { + try { + if (instant.getState == HoodieInstant.State.COMPLETED) { + val cleanMetadata = timeline.readCleanMetadata(instant) + val partitionsToCheck = targetPartition.map(Set(_)).getOrElse(cleanMetadata.getPartitionMetadata.keySet().asScala.toSet) + + for { + partitionPath <- partitionsToCheck + partitionMetadata <- Option(cleanMetadata.getPartitionMetadata.get(partitionPath)) + deletedFile <- partitionMetadata.getSuccessDeleteFiles.asScala + if matchesDeletedFileGroup(deletedFile, fileGroupId) + } { + val deletedFileName = extractActualFileName(deletedFile) + deletions(deletedFileName) = DeletionInfo(HoodieTimeline.CLEAN_ACTION, instant.requestedTime, timelineType) + } + } + } catch { + case e: Exception => + log.warn(s"Failed to process clean instant ${instant.requestedTime}: ${e.getMessage}") + } + } + + val rollbackInstants = timeline.getRollbackTimeline.getInstants.iterator().asScala + for (instant <- rollbackInstants) { + try { + if (instant.getState == HoodieInstant.State.COMPLETED) { + val rollbackMetadata = timeline.readRollbackMetadata(instant) + val partitionsToCheck = targetPartition.map(Set(_)).getOrElse(rollbackMetadata.getPartitionMetadata.keySet().asScala.toSet) + + for { + partitionPath <- partitionsToCheck + partitionMetadata <- Option(rollbackMetadata.getPartitionMetadata.get(partitionPath)) + deletedFile <- partitionMetadata.getSuccessDeleteFiles.asScala + if matchesDeletedFileGroup(deletedFile, fileGroupId) + } { + val deletedFileName = extractActualFileName(deletedFile) + deletions(deletedFileName) = DeletionInfo(HoodieTimeline.ROLLBACK_ACTION, instant.requestedTime, timelineType) + } + } + } catch { + case e: Exception => + log.warn(s"Failed to process rollback instant ${instant.requestedTime}: ${e.getMessage}") + } + } + + val replacementInstants = timeline.getCommitsAndCompactionTimeline.getInstants.iterator().asScala Review Comment: we are calling out both compacted and clustered instants as replaced instants here and for clarity we have `replace_action` which mentions whether it is a clustering action or a compaction action. I think we can change the naming convention a bit but ideally we should have this capability for the user. -- 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]
