Package org.apache.flink.table.legacy.sources

Interface LimitableTableSource<T>

@Deprecated @Internal public interface LimitableTableSource<T>
Deprecated.
This interface will not be supported in the new source design around DynamicTableSource. Use SupportsLimitPushDown instead. See FLIP-95 for more information.
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
    Description
    TableSource<T>
    applyLimit(long limit)
    Deprecated.
    Check and push down the limit to the table source.
    boolean
    isLimitPushedDown()
    Deprecated.
    Return the flag to indicate whether limit push down has been tried.

  • Method Details

    • isLimitPushedDown

      boolean isLimitPushedDown()
      Deprecated.
      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)
      Deprecated.
      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.