SnapshotReport

All Superinterfaces:: DeltaOperationReport, MetricsReport

All Known Implementing Classes:: SnapshotReportImpl

public interface SnapshotReport extends DeltaOperationReport

Defines the metadata and metrics for a snapshot construction MetricsReport

Method Summary

Modifier and Type

Method

Description

Optional<Long>

getCheckpointVersion()

default String

getOperationType()

Optional<Long>

getProvidedTimestamp()

SnapshotMetricsResult

getSnapshotMetrics()

Optional<Long>

getVersion()

For a time-travel by version query, this is the version provided.

Methods inherited from interface io.delta.kernel.metrics.DeltaOperationReport
getException, getReportUUID, getTablePath

Methods inherited from interface io.delta.kernel.metrics.MetricsReport
toJson

Method Details
- getVersion
  
  Optional<Long> getVersion()
  
  For a time-travel by version query, this is the version provided. For a time-travel by timestamp query, this is the version resolved from the provided timestamp. For a latest snapshot, this is the version read from the delta log.
  This is empty when this report is for a failed snapshot construction, and the error occurs before a version can be resolved.
  
  Returns:
  
  the version of the snapshot
- getProvidedTimestamp
  
  Optional<Long> getProvidedTimestamp()
  
  Returns:
  
  the timestamp provided for time-travel, empty if this is not a timestamp-based time-travel query
- getCheckpointVersion
  
  Optional<Long> getCheckpointVersion()
  
  Returns:
  
  the version of the checkpoint used for this snapshot, empty if no checkpoint was used or if this is a failed snapshot construction
- getSnapshotMetrics
  
  SnapshotMetricsResult getSnapshotMetrics()
  
  Returns:
  
  the metrics for this snapshot construction
- getOperationType
  
  default String getOperationType()
  
  Specified by:
  
  getOperationType in interface DeltaOperationReport
  
  Returns:
  
  a string representation of the operation this report is for