Package org.apache.spark.sql.connector.read

Interface SupportsPushDownLimit

All Superinterfaces:
ScanBuilder
@Evolving public interface SupportsPushDownLimit extends ScanBuilder
A mix-in interface for ScanBuilder. Data sources can implement this interface to push down LIMIT. We can push down LIMIT with many other operations if they follow the operator order we defined in ScanBuilder's class doc.
Since:
3.3.0

  • Method Summary

    Modifier and Type
    Method
    Description
    default boolean
    isPartiallyPushed()
    Whether the LIMIT is partially pushed or not.
    boolean
    pushLimit(int limit)
    Pushes down LIMIT to the data source.

    Methods inherited from interface org.apache.spark.sql.connector.read.ScanBuilder

    build

  • Method Details

    • pushLimit

      boolean pushLimit(int limit)
      Pushes down LIMIT to the data source.

    • isPartiallyPushed

      default boolean isPartiallyPushed()
      Whether the LIMIT is partially pushed or not. If it returns true, then Spark will do LIMIT again. This method will only be called when pushLimit(int) returns true.