org.apache.flink.table.sources

Interface LimitableTableSource<T>

All Known Implementing Classes:

FileSystemTableSource, HiveTableSource

@Experimental
public interface LimitableTableSource<T>

Adds support for limiting push-down to a TableSource. A TableSource extending this interface is able to limit the number of records.

After pushing down, source only needs to try its best to limit the number of output records, but does not need to guarantee that the number must be less than or equal to the limit.

Method Summary

Modifier and Type	Method and Description
TableSource<T>	applyLimit(long limit) Check and push down the limit to the table source.
boolean	isLimitPushedDown() Return the flag to indicate whether limit push down has been tried.

Method Detail

isLimitPushedDown

boolean isLimitPushedDown()

Return the flag to indicate whether limit push down has been tried. Must return true on the returned instance of applyLimit(long).

applyLimit

TableSource<T> applyLimit(long limit)

Check and push down the limit to the table source.

Parameters:

limit - the value which limit the number of records.

Returns:

A new cloned instance of TableSource.