org.apache.iceberg

Class FilteredManifest

java.lang.Object

org.apache.iceberg.FilteredManifest

All Implemented Interfaces:

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

public class FilteredManifest
extends java.lang.Object
implements Filterable<FilteredManifest>

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
FilteredManifest	caseSensitive(boolean isCaseSensitive) Sets case sensitivity.
void	close()
FilteredManifest	filterPartitions(Expression expr) Adds a filter expression on partition data for matching files.
FilteredManifest	filterRows(Expression expr) Adds a filter expression on data rows for matching files.
java.util.Iterator<DataFile>	iterator()
FilteredManifest	project(Schema fileProjection) Set the projection from a schema.
FilteredManifest	select(java.util.Collection<java.lang.String> selectedColumns) Selects the columns of a file manifest to read.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.iceberg.Filterable

caseInsensitive, caseSensitive, select

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

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

select

public FilteredManifest select(java.util.Collection<java.lang.String> selectedColumns)

Description copied from interface: Filterable

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.

Specified by:

select in interface Filterable<FilteredManifest>

Parameters:

selectedColumns - String column names to load from the manifest file

Returns:

a Filterable that will load only the given columns

project

public FilteredManifest project(Schema fileProjection)

Description copied from interface: Filterable

Set the projection from a schema.

Specified by:

project in interface Filterable<FilteredManifest>

Parameters:

fileProjection - a projection of the DataFile schema

Returns:

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

filterPartitions

public FilteredManifest filterPartitions(Expression expr)

Description copied from interface: Filterable

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.

Specified by:

filterPartitions in interface Filterable<FilteredManifest>

Parameters:

expr - An expression for filtering this Filterable using partition data

Returns:

a Filterable that will load only rows that match expr

filterRows

public FilteredManifest filterRows(Expression expr)

Description copied from interface: Filterable

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.

Specified by:

filterRows in interface Filterable<FilteredManifest>

Parameters:

expr - An expression for filtering this Filterable using row data

Returns:

a Filterable that will load only rows that match expr

caseSensitive

public FilteredManifest caseSensitive(boolean isCaseSensitive)

Description copied from interface: Filterable

Sets case sensitivity.

Specified by:

caseSensitive in interface Filterable<FilteredManifest>

Parameters:

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

Returns:

a Filterable that will use the specified case sensitivity

iterator

public java.util.Iterator<DataFile> iterator()

Specified by:

iterator in interface java.lang.Iterable<DataFile>

Returns:

an Iterator of DataFile. Makes defensive copies of files before returning

close

public void close()
           throws java.io.IOException

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.io.IOException