Package io.delta.kernel.metrics

Interface ScanMetricsResult

public interface ScanMetricsResult
Stores the metrics results for a ScanReport

  • Method Details

    • getTotalPlanningDurationNs

      long getTotalPlanningDurationNs()
      Returns the total duration to find, filter, and consume the scan files. This begins at the request for the scan files and terminates once all the scan files have been consumed and the scan file iterator closed. It includes reading the _delta_log, log replay, filtering optimizations, and any work from the connector before closing the scan file iterator.
      Returns:
      the total duration to find, filter, and consume the scan files

    • getNumAddFilesSeen

      long getNumAddFilesSeen()
      Returns:
      the number of AddFile actions seen during log replay (from both checkpoint and delta files). For a failed or incomplete scan this metric may be incomplete.

    • getNumAddFilesSeenFromDeltaFiles

      long getNumAddFilesSeenFromDeltaFiles()
      Returns:
      the number of AddFile actions seen during log replay from delta files only. For a failed or incomplete scan this metric may be incomplete.

    • getNumActiveAddFiles

      long getNumActiveAddFiles()
      Returns:
      the number of active AddFile actions that survived log replay (i.e. belong to the table state). For a failed or incomplete scan this metric may be incomplete.

    • getNumDuplicateAddFiles

      long getNumDuplicateAddFiles()
      Returns the number of duplicate AddFile actions seen during log replay. The same AddFile (same path and DV) can be present in multiple commit files when stats collection is run on the table. In this case, the same AddFile will be added with stats without removing the original.
      Returns:
      the number of AddFile actions seen during log replay that are duplicates. For a failed or incomplete scan this metric may be incomplete.

    • getNumRemoveFilesSeenFromDeltaFiles

      long getNumRemoveFilesSeenFromDeltaFiles()
      Returns:
      the number of RemoveFiles seen in log replay (only from delta files). For a failed or incomplete scan this metric may be incomplete.