io.delta.kernel.internal

Class ScanImpl

java.lang.Object

io.delta.kernel.internal.ScanImpl

All Implemented Interfaces:

Scan

public class ScanImpl
extends java.lang.Object
implements Scan

Implementation of Scan

Constructor Summary

Constructors

Constructor and Description
ScanImpl(StructType snapshotSchema, StructType readSchema, Lazy<Tuple2<Protocol,Metadata>> protocolAndMetadata, CloseableIterator<AddFile> filesIter, java.util.Optional<Expression> filter, Path dataPath)

Method Summary

Modifier and Type	Method and Description
java.util.Optional<Expression>	getRemainingFilter() Get the remaining filter that is not guaranteed to be satisfied for the data Delta Kernel returns.
CloseableIterator<ColumnarBatch>	getScanFiles(TableClient tableClient) Get an iterator of data files in this version of scan that survived the predicate pruning.
Row	getScanState(TableClient tableClient) Get the scan state associated with the current scan.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.delta.kernel.Scan

readData

Constructor Detail

ScanImpl

public ScanImpl(StructType snapshotSchema,
                StructType readSchema,
                Lazy<Tuple2<Protocol,Metadata>> protocolAndMetadata,
                CloseableIterator<AddFile> filesIter,
                java.util.Optional<Expression> filter,
                Path dataPath)

Method Detail

getScanFiles

public CloseableIterator<ColumnarBatch> getScanFiles(TableClient tableClient)

Get an iterator of data files in this version of scan that survived the predicate pruning.

Specified by:

getScanFiles in interface Scan

Parameters:

tableClient - TableClient instance to use in Delta Kernel.

Returns:

data in ColumnarBatch batch format. Each row correspond to one survived file.

getScanState

public Row getScanState(TableClient tableClient)

Description copied from interface: Scan

Get the scan state associated with the current scan. This state is common across all files in the scan to be read.

Specified by:

getScanState in interface Scan

Parameters:

tableClient - TableClient instance to use in Delta Kernel.

Returns:

Scan state in Row format.

getRemainingFilter

public java.util.Optional<Expression> getRemainingFilter()

Description copied from interface: Scan

Get the remaining filter that is not guaranteed to be satisfied for the data Delta Kernel returns. This filter is used by Delta Kernel to do data skipping when possible.

Specified by:

getRemainingFilter in interface Scan

Returns:

the remaining filter as an Expression.