Package io.delta.kernel.metrics

Interface ScanReport

All Superinterfaces:
DeltaOperationReport, MetricsReport
All Known Implementing Classes:
ScanReportImpl
public interface ScanReport extends DeltaOperationReport
Defines the metadata and metrics for a Scan MetricsReport

  • Method Details

    • getTableVersion

      long getTableVersion()
      Returns:
      the version of the table in this scan

    • getTableSchema

      StructType getTableSchema()
      Returns:
      the schema of the table for this scan

    • getSnapshotReportUUID

      UUID getSnapshotReportUUID()
      Returns:
      the DeltaOperationReport.getReportUUID() for the snapshot this scan was created from

    • getFilter

      Optional<Predicate> getFilter()
      Returns:
      the filter provided when building the scan

    • getReadSchema

      StructType getReadSchema()
      Returns:
      the read schema provided when building the scan

    • getPartitionPredicate

      Optional<Predicate> getPartitionPredicate()
      Returns:
      the part of getFilter() that was used for partition pruning

    • getDataSkippingFilter

      Optional<Predicate> getDataSkippingFilter()
      Returns:
      the filter used for data skipping using the file statistics

    • getIsFullyConsumed

      boolean getIsFullyConsumed()
      Whether the scan file iterator had been fully consumed when it was closed. The iterator may be closed early (before being fully consumed) either due to an exception originating within connector code or intentionally (such as for a LIMIT query).
      Returns:
      whether the scan file iterator had been fully consumed when it was closed

    • getScanMetrics

      ScanMetricsResult getScanMetrics()
      Returns:
      the metrics for this scan

    • getOperationType

      default String getOperationType()
      Specified by:
      getOperationType in interface DeltaOperationReport
      Returns:
      a string representation of the operation this report is for