vamshikrishnakyatham commented on code in PR #13745: URL: https://github.com/apache/hudi/pull/13745#discussion_r2345484001
########## hudi-spark-datasource/hudi-spark/src/main/scala/org/apache/spark/sql/hudi/command/procedures/ShowFileGroupHistoryProcedure.scala: ########## @@ -0,0 +1,274 @@ +/* + * 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.table.HoodieTableMetaClient + +import org.apache.spark.internal.Logging +import org.apache.spark.sql.Row +import org.apache.spark.sql.types.{DataTypes, StructType} + +import java.util +import java.util.function.Supplier + +import scala.collection.JavaConverters._ + +/** + * Spark SQL procedure to show the complete history of a specific file group in a Hudi table. + * + * This procedure displays comprehensive information about all operations performed on a specific file group, + * including commits, updates, deletions, replacements, and metadata changes in a detailed partition specific view. It tracks the lifecycle of + * files from creation through various modifications and eventual deletion or replacement. + * + * == Parameters == + * - `table`: Optional. The name of the Hudi table to query (mutually exclusive with `path`) + * - `path`: Optional. The base path of the Hudi table (mutually exclusive with `table`) + * - `fileGroupId`: Required. The unique identifier of the file group to track + * - `partition`: Optional. Specific partition to filter results (default: all partitions) + * - `showArchived`: Optional. Whether to include archived timeline data (default: false) + * - `limit`: Optional. Maximum number of history entries to return (default: 20) + * - `filter`: Optional. SQL expression to filter results (default: empty string) + * - `startTime`: Optional. Start timestamp for filtering results (format: yyyyMMddHHmmss) + * - `endTime`: Optional. End timestamp for filtering results (format: yyyyMMddHHmmss) + * + * == Output Schema == + * - `instant_time`: Timestamp when the operation was performed + * - `completion_time`: Time when the operation completed (null for pending operations) + * - `action`: The action type (commit, deltacommit, compaction, clustering, etc.) + * - `timeline_type`: Whether the data is from ACTIVE or ARCHIVED timeline + * - `state`: Current state of the operation (REQUESTED, INFLIGHT, COMPLETED) + * - `partition_path`: Partition path where the file group resides + * - `file_name`: Name of the file in the file group + * - `operation_type`: Type of write operation (INSERT, UPDATE, UPSERT, DELETE) + * - `num_writes`: Total number of records written in this operation + * - `num_inserts`: Number of new records inserted + * - `num_updates`: Number of existing records updated + * - `num_deletes`: Number of records deleted + * - `file_size_bytes`: Size of the file in bytes + * - `total_write_bytes`: Total bytes written during the operation + * - `prev_commit`: Previous commit timestamp that this operation builds upon + * - `was_deleted`: Whether the file was deleted in a subsequent operation + * - `delete_action`: Action that caused the deletion (clean, rollback, etc.) + * - `delete_instant`: Timestamp when the deletion occurred + * - `is_replaced`: Whether the file was replaced in a subsequent operation + * - `replace_action`: Action that caused the replacement (compaction, clustering, etc.) + * - `replace_instant`: Timestamp when the replacement occurred + * - `total_write_errors`: Number of write errors encountered + * - `total_scan_time_ms`: Total time spent scanning during the operation + * - `total_upsert_time_ms`: Total time spent in upsert processing + * - `total_create_time_ms`: Total time spent in file creation + * - `prev_base_file`: Previous base file that was replaced (for compaction/clustering) + * - `column_stats_available`: Whether column statistics are available for this file Review Comment: what we can do is set them to null instead but it wouldn't look good -- 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]
