t

org.apache.spark.sql.connector.read

SupportsPushDownV2Filters

trait SupportsPushDownV2Filters extends ScanBuilder

A mix-in interface for ScanBuilder. Data sources can implement this interface to push down V2 Predicate to the data source and reduce the size of the data to be read. Please Note that this interface is preferred over SupportsPushDownFilters, which uses V1 org.apache.spark.sql.sources.Filter and is less efficient due to the internal -> external data conversion.

Annotations
@Evolving()
Since

3.3.0

Linear Supertypes
ScanBuilder, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SupportsPushDownV2Filters
  2. ScanBuilder
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def build(): Scan
    Definition Classes
    ScanBuilder
  2. abstract def pushPredicates(predicates: Array[Predicate]): Array[Predicate]

    Pushes down predicates, and returns predicates that need to be evaluated after scanning.

    Pushes down predicates, and returns predicates that need to be evaluated after scanning.

    Rows should be returned from the data source if and only if all of the predicates match. That is, predicates must be interpreted as ANDed together.

  3. abstract def pushedPredicates(): Array[Predicate]

    Returns the predicates that are pushed to the data source via #pushPredicates(Predicate[]).

    Returns the predicates that are pushed to the data source via #pushPredicates(Predicate[]).

    There are 3 kinds of predicates:

    • pushable predicates which don't need to be evaluated again after scanning.
    • pushable predicates which still need to be evaluated after scanning, e.g. parquet row group predicate.
    • non-pushable predicates.

    Both case 1 and 2 should be considered as pushed predicates and should be returned by this method.

    It's possible that there is no predicates in the query and #pushPredicates(Predicate[]) is never called, empty array should be returned for this case.

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  14. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  15. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  16. def toString(): String
    Definition Classes
    AnyRef → Any
  17. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  18. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  19. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()

Inherited from ScanBuilder

Inherited from AnyRef

Inherited from Any

Ungrouped