org.apache.iceberg

Interface Filterable<T extends Filterable<T>>

Type Parameters:

T - Java class returned by filter methods, also filterable

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, CloseableIterable<DataFile>, java.lang.Iterable<DataFile>

All Known Implementing Classes:

FilteredManifest, ManifestReader

public interface Filterable<T extends Filterable<T>>
extends CloseableIterable<DataFile>

Methods to filter files in a snapshot or manifest when reading.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.iceberg.io.CloseableIterable

CloseableIterable.ConcatCloseableIterable<E>

Method Summary

Modifier and Type	Method and Description
default T	caseInsensitive() Sets case insensitive binding and projection.
default T	caseSensitive() Sets case sensitive binding and projection.
T	caseSensitive(boolean isCaseSensitive) Sets case sensitivity.
T	filterPartitions(Expression expr) Adds a filter expression on partition data for matching files.
T	filterRows(Expression expr) Adds a filter expression on data rows for matching files.
T	project(Schema fileProjection) Set the projection from a schema.
T	select(java.util.Collection<java.lang.String> columns) Selects the columns of a file manifest to read.
default T	select(java.lang.String... columns) Selects the columns of a file manifest to read.

Methods inherited from interface org.apache.iceberg.io.CloseableIterable

combine, concat, empty, filter, transform, withNoopClose, withNoopClose

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Methods inherited from interface java.io.Closeable

close

Method Detail

select

default T select(java.lang.String... columns)

Selects the columns of a file manifest to read.

If columns are set multiple times, the last set of columns will be read.

If the Filterable object has partition filters, they will be added to the returned partial.

For a list of column names, see the table format specification.

Parameters:

columns - String column names to load from the manifest file

Returns:

a Filterable that will load only the given columns

select

T select(java.util.Collection<java.lang.String> columns)

Selects the columns of a file manifest to read.

If columns are set multiple times, the last set of columns will be read.

If the Filterable object has partition filters, they will be added to the returned partial.

For a list of column names, see the table format specification.

Parameters:

columns - String column names to load from the manifest file

Returns:

a Filterable that will load only the given columns

project

T project(Schema fileProjection)

Set the projection from a schema.

Parameters:

fileProjection - a projection of the DataFile schema

Returns:

a Filterable that will load only the given schema's columns

filterPartitions

T filterPartitions(Expression expr)

Adds a filter expression on partition data for matching files.

If the Filterable object already has partition filters, the new filter will be added as an additional requirement. The result filter expression will be the result of expr and any existing filters.

If the Filterable object has columns selected, they will be added to the returned partial.

Parameters:

expr - An expression for filtering this Filterable using partition data

Returns:

a Filterable that will load only rows that match expr

filterRows

T filterRows(Expression expr)

Adds a filter expression on data rows for matching files.

Expressions passed to this function will be converted to partition expressions before they are used to filter data files.

If the Filterable object already has partition filters, the new filter will be added as an additional requirement. The result filter expression will be the result of expr and any existing filters.

If the Filterable object has columns selected, they will be added to the returned partial.

Parameters:

expr - An expression for filtering this Filterable using row data

Returns:

a Filterable that will load only rows that match expr

caseSensitive

T caseSensitive(boolean isCaseSensitive)

Sets case sensitivity.

Parameters:

isCaseSensitive - true if expression binding and schema projection should be case sensitive

Returns:

a Filterable that will use the specified case sensitivity

caseSensitive

default T caseSensitive()

Sets case sensitive binding and projection.

Returns:

a Filterable that will case sensitive binding and projection

caseInsensitive

default T caseInsensitive()

Sets case insensitive binding and projection.

Returns:

a Filterable that will case insensitive binding and projection