Interface SupportsPushDownV2Filters
- All Superinterfaces:
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 Filter
and is less efficient due to the
internal -> external data conversion.- Since:
- 3.3.0
-
Method Summary
Modifier and TypeMethodDescriptionReturns the predicates that are pushed to the data source viapushPredicates(Predicate[])
.pushPredicates
(Predicate[] predicates) Pushes down predicates, and returns predicates that need to be evaluated after scanning.Methods inherited from interface org.apache.spark.sql.connector.read.ScanBuilder
build
-
Method Details
-
pushPredicates
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.
-
pushedPredicates
Predicate[] pushedPredicates()Returns the predicates that are pushed to the data source viapushPredicates(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.
-