Package org.apache.flink.table.connector.source.abilities

Interface SupportsLimitPushDown

  • All Known Implementing Classes:
    DataGenTableSource, FileSystemTableSource
    @PublicEvolving
public interface SupportsLimitPushDown
    Enables to push down a limit (the expected maximum number of produced records) into a ScanTableSource.

    It might be beneficial to perform the limiting as early as possible in order to be close to the actual data generation.

    A source can perform the limiting on a best-effort basis. During runtime, it must not guarantee that the number of emitted records is less than or equal to the limit.

    Regardless if this interface is implemented or not, a limit is also applied in a subsequent operation after the source.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void applyLimit​(long limit)
      Provides the expected maximum number of produced records for limiting on a best-effort basis.

    • Method Detail

      • applyLimit

        void applyLimit​(long limit)
        Provides the expected maximum number of produced records for limiting on a best-effort basis.