[SPARK-30648][SQL] Support filters pushdown in JSON datasource #27366
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,161 @@ | ||
| /* | ||
| * Licensed to the Apache Software Foundation (ASF) under one or more | ||
| * contributor license agreements. See the NOTICE file distributed with | ||
| * this work for additional information regarding copyright ownership. | ||
| * The ASF licenses this file to You under the Apache License, Version 2.0 | ||
| * (the "License"); you may not use this file except in compliance with | ||
| * the License. You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| package org.apache.spark.sql.catalyst | ||
|
|
||
| import scala.util.Try | ||
|
|
||
| import org.apache.spark.sql.catalyst.StructFilters._ | ||
| import org.apache.spark.sql.catalyst.expressions._ | ||
| import org.apache.spark.sql.sources | ||
| import org.apache.spark.sql.types.{BooleanType, StructType} | ||
|
|
||
| /** | ||
| * The class provides API for applying pushed down filters to partially or | ||
| * fully set internal rows that have the struct schema. | ||
| * | ||
| * @param pushedFilters The pushed down source filters. The filters should refer to | ||
| * the fields of the provided schema. | ||
| * @param schema The required schema of records from datasource files. | ||
| */ | ||
| abstract class StructFilters(pushedFilters: Seq[sources.Filter], schema: StructType) { | ||
|
|
||
| protected val filters = pushedFilters.filter(checkFilterRefs(_, schema.fieldNames.toSet)) | ||
|
Contributor
There was a problem hiding this comment. shall we pre-create the set?
Contributor
There was a problem hiding this comment. Actually we can just call the |
||
|
|
||
| /** | ||
| * Applies pushed down source filters to the given row assuming that | ||
| * value at `index` has been already set. | ||
| * | ||
| * @param row The row with fully or partially set values. | ||
| * @param index The index of already set value. | ||
| * @return true if currently processed row can be skipped otherwise false. | ||
| */ | ||
| def skipRow(row: InternalRow, index: Int): Boolean | ||
|
|
||
| /** | ||
| * Resets states of pushed down filters. The method must be called before | ||
| * precessing any new row otherwise skipRow() may return wrong result. | ||
| */ | ||
| def reset(): Unit | ||
|
|
||
| /** | ||
| * Compiles source filters to a predicate. | ||
| */ | ||
| def toPredicate(filters: Seq[sources.Filter]): BasePredicate = { | ||
| val reducedExpr = filters | ||
| .sortBy(_.references.length) | ||
| .flatMap(filterToExpression(_, toRef)) | ||
| .reduce(And) | ||
| Predicate.create(reducedExpr) | ||
| } | ||
|
|
||
| // Finds a filter attribute in the schema and converts it to a `BoundReference` | ||
| def toRef(attr: String): Option[BoundReference] = { | ||
|
MaxGekk marked this conversation as resolved.
Outdated
|
||
| schema.getFieldIndex(attr).map { index => | ||
|
dongjoon-hyun marked this conversation as resolved.
cloud-fan marked this conversation as resolved.
|
||
| val field = schema(index) | ||
| BoundReference(schema.fieldIndex(attr), field.dataType, field.nullable) | ||
|
Member
There was a problem hiding this comment. Isn't
Member
Author
There was a problem hiding this comment. Right, I will replace it by |
||
| } | ||
| } | ||
| } | ||
|
|
||
| object StructFilters { | ||
| private def checkFilterRefs(filter: sources.Filter, fieldNames: Set[String]): Boolean = { | ||
| filter.references.forall(fieldNames.contains) | ||
|
MaxGekk marked this conversation as resolved.
|
||
| } | ||
|
|
||
| /** | ||
| * Returns the filters currently supported by the datasource. | ||
| * @param filters The filters pushed down to the datasource. | ||
| * @param schema data schema of datasource files. | ||
| * @return a sub-set of `filters` that can be handled by the datasource. | ||
| */ | ||
| def pushedFilters(filters: Array[sources.Filter], schema: StructType): Array[sources.Filter] = { | ||
| val fieldNames = schema.fieldNames.toSet | ||
| filters.filter(checkFilterRefs(_, fieldNames)) | ||
| } | ||
|
|
||
| private def zip[A, B](a: Option[A], b: Option[B]): Option[(A, B)] = { | ||
|
dongjoon-hyun marked this conversation as resolved.
|
||
| a.zip(b).headOption | ||
| } | ||
|
|
||
| private def toLiteral(value: Any): Option[Literal] = { | ||
| Try(Literal(value)).toOption | ||
| } | ||
|
|
||
| /** | ||
| * Converts a filter to an expression and binds it to row positions. | ||
| * | ||
| * @param filter The filter to convert. | ||
| * @param toRef The function converts a filter attribute to a bound reference. | ||
| * @return some expression with resolved attributes or None if the conversion | ||
| * of the given filter to an expression is impossible. | ||
| */ | ||
| def filterToExpression( | ||
| filter: sources.Filter, | ||
| toRef: String => Option[BoundReference]): Option[Expression] = { | ||
| def zipAttributeAndValue(name: String, value: Any): Option[(BoundReference, Literal)] = { | ||
| zip(toRef(name), toLiteral(value)) | ||
| } | ||
| def translate(filter: sources.Filter): Option[Expression] = filter match { | ||
| case sources.And(left, right) => | ||
| zip(translate(left), translate(right)).map(And.tupled) | ||
| case sources.Or(left, right) => | ||
| zip(translate(left), translate(right)).map(Or.tupled) | ||
| case sources.Not(child) => | ||
| translate(child).map(Not) | ||
| case sources.EqualTo(attribute, value) => | ||
| zipAttributeAndValue(attribute, value).map(EqualTo.tupled) | ||
| case sources.EqualNullSafe(attribute, value) => | ||
| zipAttributeAndValue(attribute, value).map(EqualNullSafe.tupled) | ||
| case sources.IsNull(attribute) => | ||
| toRef(attribute).map(IsNull) | ||
| case sources.IsNotNull(attribute) => | ||
| toRef(attribute).map(IsNotNull) | ||
| case sources.In(attribute, values) => | ||
| val literals = values.toSeq.flatMap(toLiteral) | ||
| if (literals.length == values.length) { | ||
| toRef(attribute).map(In(_, literals)) | ||
| } else { | ||
| None | ||
| } | ||
| case sources.GreaterThan(attribute, value) => | ||
| zipAttributeAndValue(attribute, value).map(GreaterThan.tupled) | ||
| case sources.GreaterThanOrEqual(attribute, value) => | ||
| zipAttributeAndValue(attribute, value).map(GreaterThanOrEqual.tupled) | ||
| case sources.LessThan(attribute, value) => | ||
| zipAttributeAndValue(attribute, value).map(LessThan.tupled) | ||
| case sources.LessThanOrEqual(attribute, value) => | ||
| zipAttributeAndValue(attribute, value).map(LessThanOrEqual.tupled) | ||
| case sources.StringContains(attribute, value) => | ||
| zipAttributeAndValue(attribute, value).map(Contains.tupled) | ||
| case sources.StringStartsWith(attribute, value) => | ||
| zipAttributeAndValue(attribute, value).map(StartsWith.tupled) | ||
| case sources.StringEndsWith(attribute, value) => | ||
| zipAttributeAndValue(attribute, value).map(EndsWith.tupled) | ||
| case sources.AlwaysTrue() => | ||
| Some(Literal(true, BooleanType)) | ||
| case sources.AlwaysFalse() => | ||
| Some(Literal(false, BooleanType)) | ||
| } | ||
| translate(filter) | ||
| } | ||
| } | ||
|
|
||
| class NoopFilters extends StructFilters(Seq.empty, new StructType()) { | ||
| override def skipRow(row: InternalRow, index: Int): Boolean = false | ||
| override def reset(): Unit = {} | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.