org.apache.paimon.table.source

Class ReadBuilderImpl

java.lang.Object

org.apache.paimon.table.source.ReadBuilderImpl

All Implemented Interfaces:

Serializable, ReadBuilder

public class ReadBuilderImpl
extends Object
implements ReadBuilder

Implementation for ReadBuilder.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ReadBuilderImpl(InnerTable table)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
int	hashCode()
TableRead	newRead() Create a TableRead to read Splits.
TableScan	newScan() Create a TableScan to perform batch planning.
StreamTableScan	newStreamScan() Create a TableScan to perform streaming planning.
RowType	readType() Returns read row type.
String	tableName() A name to identify the table.
ReadBuilder	withBucketFilter(Filter<Integer> bucketFilter) Push bucket filter.
ReadBuilder	withFilter(Predicate filter) Push filters, will filter the data as much as possible, but it is not guaranteed that it is a complete filter.
ReadBuilder	withLimit(int limit) the row number pushed down.
ReadBuilder	withPartitionFilter(Map<String,String> partitionSpec) Push partition filter.
ReadBuilder	withProjection(int[] projection) Apply projection to the reader, if you need nested row pruning, use ReadBuilder.withReadType(RowType) instead.
ReadBuilder	withReadType(RowType readType) Push read row type to the reader, support nested row pruning.
ReadBuilder	withShard(int indexOfThisSubtask, int numberOfParallelSubtasks) Specify the shard to be read, and allocate sharded files to read records.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.paimon.table.source.ReadBuilder

withFilter, withProjection

Constructor Detail

ReadBuilderImpl

public ReadBuilderImpl(InnerTable table)

Method Detail

tableName

public String tableName()

Description copied from interface: ReadBuilder

A name to identify the table.

Specified by:

tableName in interface ReadBuilder

readType

public RowType readType()

Description copied from interface: ReadBuilder

Returns read row type.

Specified by:

readType in interface ReadBuilder

withFilter

public ReadBuilder withFilter(Predicate filter)

Description copied from interface: ReadBuilder

Push filters, will filter the data as much as possible, but it is not guaranteed that it is a complete filter.

Specified by:

withFilter in interface ReadBuilder

withPartitionFilter

public ReadBuilder withPartitionFilter(Map<String,String> partitionSpec)

Description copied from interface: ReadBuilder

Push partition filter.

Specified by:

withPartitionFilter in interface ReadBuilder

withReadType

public ReadBuilder withReadType(RowType readType)

Description copied from interface: ReadBuilder

Push read row type to the reader, support nested row pruning.

Specified by:

withReadType in interface ReadBuilder

Parameters:

readType - read row type, can be a pruned type from Table.rowType()

withProjection

public ReadBuilder withProjection(int[] projection)

Description copied from interface: ReadBuilder

Apply projection to the reader, if you need nested row pruning, use ReadBuilder.withReadType(RowType) instead.

Specified by:

withProjection in interface ReadBuilder

withLimit

public ReadBuilder withLimit(int limit)

Description copied from interface: ReadBuilder

the row number pushed down.

Specified by:

withLimit in interface ReadBuilder

withShard

public ReadBuilder withShard(int indexOfThisSubtask,
                             int numberOfParallelSubtasks)

Description copied from interface: ReadBuilder

Specify the shard to be read, and allocate sharded files to read records. Note that this method cannot be used simultaneously with ReadBuilder.withBucketFilter(Filter).

Reason: Sharding and bucket filtering are different logical mechanisms for selecting subsets of table data. Applying both methods simultaneously introduces conflicting selection criteria.

Specified by:

withShard in interface ReadBuilder

withBucketFilter

public ReadBuilder withBucketFilter(Filter<Integer> bucketFilter)

Description copied from interface: ReadBuilder

Push bucket filter. Note that this method cannot be used simultaneously with ReadBuilder.withShard(int, int).

Reason: Bucket filtering and sharding are different logical mechanisms for selecting subsets of table data. Applying both methods simultaneously introduces conflicting selection criteria.

Specified by:

withBucketFilter in interface ReadBuilder

newScan

public TableScan newScan()

Description copied from interface: ReadBuilder

Create a TableScan to perform batch planning.

Specified by:

newScan in interface ReadBuilder

newStreamScan

public StreamTableScan newStreamScan()

Description copied from interface: ReadBuilder

Create a TableScan to perform streaming planning.

Specified by:

newStreamScan in interface ReadBuilder

newRead

public TableRead newRead()

Description copied from interface: ReadBuilder

Create a TableRead to read Splits.

Specified by:

newRead in interface ReadBuilder

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object