io.delta.kernel

Interface ScanBuilder

All Known Implementing Classes:

ScanBuilderImpl

@Evolving
public interface ScanBuilder

Builder to construct Scan object.

Since:

3.0.0

Method Summary

Modifier and Type	Method and Description
Scan	build()
ScanBuilder	withFilter(TableClient tableClient, Predicate predicate) 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.

Method Detail

withFilter

ScanBuilder withFilter(TableClient tableClient,
                       Predicate predicate)

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

Parameters:

tableClient - TableClient instance to use in Delta Kernel.

predicate - a Predicate to prune the metadata or data.

Returns:

A ScanBuilder with filter applied.

withReadSchema

ScanBuilder withReadSchema(TableClient tableClient,
                           StructType readSchema)

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

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

Scan build()

Returns:

Build the instance