Package io.delta.kernel.internal.metrics

Class ScanReportImpl

Object

io.delta.kernel.internal.metrics.DeltaOperationReportImpl

io.delta.kernel.internal.metrics.ScanReportImpl

All Implemented Interfaces:

DeltaOperationReport, MetricsReport, ScanReport

public class ScanReportImpl
extends DeltaOperationReportImpl
implements ScanReport

A basic POJO implementation of ScanReport for creating them

Constructor Summary

Constructors

Constructor	Description
ScanReportImpl(String tablePath, long tableVersion, StructType tableSchema, UUID snapshotReportUUID, Optional<Predicate> filter, StructType readSchema, Optional<Predicate> partitionPredicate, Optional<Predicate> dataSkippingFilter, boolean isFullyConsumed, ScanMetrics scanMetrics, Optional<Exception> exception)

Method Summary

Modifier and Type	Method	Description
Optional<Predicate>	getDataSkippingFilter()
Optional<Predicate>	getFilter()
boolean	getIsFullyConsumed()	Whether the scan file iterator had been fully consumed when it was closed.
Optional<Predicate>	getPartitionPredicate()
StructType	getReadSchema()
ScanMetricsResult	getScanMetrics()
UUID	getSnapshotReportUUID()
StructType	getTableSchema()
long	getTableVersion()
String	toJson()	Converts this metrics report to a JSON string representation.

Methods inherited from class io.delta.kernel.internal.metrics.DeltaOperationReportImpl

getException, getReportUUID, getTablePath

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.delta.kernel.metrics.DeltaOperationReport

getException, getReportUUID, getTablePath

Methods inherited from interface io.delta.kernel.metrics.ScanReport

getOperationType

Constructor Details

ScanReportImpl

public ScanReportImpl(String tablePath,
 long tableVersion,
 StructType tableSchema,
 UUID snapshotReportUUID,
 Optional<Predicate> filter,
 StructType readSchema,
 Optional<Predicate> partitionPredicate,
 Optional<Predicate> dataSkippingFilter,
 boolean isFullyConsumed,
 ScanMetrics scanMetrics,
 Optional<Exception> exception)

Method Details

getTableVersion

public long getTableVersion()

Specified by:

getTableVersion in interface ScanReport

Returns:

the version of the table in this scan

getTableSchema

public StructType getTableSchema()

Specified by:

getTableSchema in interface ScanReport

Returns:

the schema of the table for this scan

getSnapshotReportUUID

public UUID getSnapshotReportUUID()

Specified by:

getSnapshotReportUUID in interface ScanReport

Returns:

the DeltaOperationReport.getReportUUID() for the snapshot this scan was created from

getFilter

public Optional<Predicate> getFilter()

Specified by:

getFilter in interface ScanReport

Returns:

the filter provided when building the scan

getReadSchema

public StructType getReadSchema()

Specified by:

getReadSchema in interface ScanReport

Returns:

the read schema provided when building the scan

getPartitionPredicate

public Optional<Predicate> getPartitionPredicate()

Specified by:

getPartitionPredicate in interface ScanReport

Returns:

the part of ScanReport.getFilter() that was used for partition pruning

getDataSkippingFilter

public Optional<Predicate> getDataSkippingFilter()

Specified by:

getDataSkippingFilter in interface ScanReport

Returns:

the filter used for data skipping using the file statistics

getIsFullyConsumed

public boolean getIsFullyConsumed()

Description copied from interface: ScanReport

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).

Specified by:

getIsFullyConsumed in interface ScanReport

Returns:

whether the scan file iterator had been fully consumed when it was closed

getScanMetrics

public ScanMetricsResult getScanMetrics()

Specified by:

getScanMetrics in interface ScanReport

Returns:

the metrics for this scan

toJson

public String toJson()
              throws com.fasterxml.jackson.core.JsonProcessingException

Description copied from interface: MetricsReport

Converts this metrics report to a JSON string representation.

Specified by:

toJson in interface MetricsReport

Returns:

a JSON string representation of this metrics report

Throws:

com.fasterxml.jackson.core.JsonProcessingException - if the report cannot be serialized to JSON