io.delta.kernel.internal

Class ScanBuilderImpl

java.lang.Object

io.delta.kernel.internal.ScanBuilderImpl

All Implemented Interfaces:

ScanBuilder

public class ScanBuilderImpl
extends java.lang.Object
implements ScanBuilder

Implementation of ScanBuilder.

Constructor Summary

Constructors

Constructor and Description
ScanBuilderImpl(Path dataPath, Lazy<Tuple2<Protocol,Metadata>> protocolAndMetadata, StructType snapshotSchema, CloseableIterator<AddFile> filesIter, TableClient tableClient)

Method Summary

Modifier and Type	Method and Description
Scan	build()
ScanBuilder	withFilter(TableClient tableClient, Expression filter) Apply the given filter expression to prune any files that do not contain data satisfying the given filter.
ScanBuilder	withReadSchema(TableClient tableClient, StructType readSchema) Apply the given readSchema.

Methods inherited from class java.lang.Object

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

Constructor Detail

ScanBuilderImpl

public ScanBuilderImpl(Path dataPath,
                       Lazy<Tuple2<Protocol,Metadata>> protocolAndMetadata,
                       StructType snapshotSchema,
                       CloseableIterator<AddFile> filesIter,
                       TableClient tableClient)

Method Detail

withFilter

public ScanBuilder withFilter(TableClient tableClient,
                              Expression filter)

Description copied from interface: ScanBuilder

Apply the given filter expression to prune any files that do not contain data satisfying the given filter.

Specified by:

withFilter in interface ScanBuilder

Parameters:

tableClient - TableClient instance to use in Delta Kernel.

filter - an Expression which evaluates to boolean.

Returns:

A ScanBuilder with filter applied.

withReadSchema

public ScanBuilder withReadSchema(TableClient tableClient,
                                  StructType readSchema)

Description copied from interface: ScanBuilder

Apply the given readSchema. If the builder already has a projection applied, calling this again replaces the existing projection.

Specified by:

withReadSchema in interface ScanBuilder

Parameters:

tableClient - TableClient instance to use in Delta Kernel.

readSchema - Subset of columns to read from the Delta table.

Returns:

A ScanBuilder with projection pruning.

build

public Scan build()

Specified by:

build in interface ScanBuilder

Returns:

Build the instance