szehon-ho commented on code in PR #5302: URL: https://github.com/apache/iceberg/pull/5302#discussion_r946181165
########## spark/v3.3/spark/src/main/java/org/apache/iceberg/spark/SparkV2Filters.java: ########## @@ -0,0 +1,375 @@ +/* + * 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.iceberg.spark; + +import static org.apache.iceberg.expressions.Expressions.and; +import static org.apache.iceberg.expressions.Expressions.equal; +import static org.apache.iceberg.expressions.Expressions.greaterThan; +import static org.apache.iceberg.expressions.Expressions.greaterThanOrEqual; +import static org.apache.iceberg.expressions.Expressions.in; +import static org.apache.iceberg.expressions.Expressions.isNaN; +import static org.apache.iceberg.expressions.Expressions.isNull; +import static org.apache.iceberg.expressions.Expressions.lessThan; +import static org.apache.iceberg.expressions.Expressions.lessThanOrEqual; +import static org.apache.iceberg.expressions.Expressions.not; +import static org.apache.iceberg.expressions.Expressions.notIn; +import static org.apache.iceberg.expressions.Expressions.notNull; +import static org.apache.iceberg.expressions.Expressions.or; +import static org.apache.iceberg.expressions.Expressions.startsWith; + +import java.util.Map; +import java.util.Objects; +import java.util.regex.Matcher; +import java.util.regex.Pattern; +import java.util.stream.Collectors; +import java.util.stream.Stream; +import org.apache.iceberg.expressions.Expression; +import org.apache.iceberg.expressions.Expressions; +import org.apache.iceberg.relocated.com.google.common.base.Preconditions; +import org.apache.iceberg.relocated.com.google.common.collect.ImmutableMap; +import org.apache.iceberg.util.NaNUtil; +import org.apache.spark.sql.connector.expressions.LiteralValue; +import org.apache.spark.sql.connector.expressions.NamedReference; +import org.apache.spark.sql.connector.expressions.filter.And; +import org.apache.spark.sql.connector.expressions.filter.Not; +import org.apache.spark.sql.connector.expressions.filter.Or; +import org.apache.spark.sql.connector.expressions.filter.Predicate; +import org.apache.spark.unsafe.types.UTF8String; + +public class SparkV2Filters { + + private static final Pattern BACKTICKS_PATTERN = Pattern.compile("([`])(.|$)"); + + private SparkV2Filters() {} + + private static final Map<String, Expression.Operation> FILTERS = + ImmutableMap.<String, Expression.Operation>builder() + .put("ALWAYS_TRUE", Expression.Operation.TRUE) + .put("ALWAYS_FALSE", Expression.Operation.FALSE) + .put("=", Expression.Operation.EQ) + .put("<=>", Expression.Operation.EQ) + .put(">", Expression.Operation.GT) + .put(">=", Expression.Operation.GT_EQ) + .put("<", Expression.Operation.LT) + .put("<=", Expression.Operation.LT_EQ) + .put("IN", Expression.Operation.IN) + .put("IS_NULL", Expression.Operation.IS_NULL) + .put("IS_NOT_NULL", Expression.Operation.NOT_NULL) + .put("AND", Expression.Operation.AND) + .put("OR", Expression.Operation.OR) + .put("NOT", Expression.Operation.NOT) + .put("STARTS_WITH", Expression.Operation.STARTS_WITH) + .build(); + + public static Expression convert(Predicate[] predicates) { + Expression expression = Expressions.alwaysTrue(); + for (Predicate predicate : predicates) { + Expression converted = convert(predicate); + Preconditions.checkArgument( + converted != null, "Cannot convert predicate to Iceberg: %s", predicate); + expression = Expressions.and(expression, converted); + } + return expression; + } + + @SuppressWarnings({"checkstyle:CyclomaticComplexity", "checkstyle:MethodLength"}) + public static Expression convert(Predicate predicate) { + if (checkIfPredicateValid(predicate) == null) { + return null; + } + + Expression.Operation op = FILTERS.get(predicate.name()); + if (op != null) { + switch (op) { + case TRUE: + return Expressions.alwaysTrue(); + + case FALSE: + return Expressions.alwaysFalse(); + + case IS_NULL: + return isNull(unquote(predicate.children()[0].toString())); + + case NOT_NULL: + return notNull(unquote(predicate.children()[0].toString())); + + case LT: + if (predicate.children()[1] instanceof LiteralValue) { + return lessThan( + unquote(predicate.children()[0].toString()), + convertUTF8StringIfNecessary(((LiteralValue) predicate.children()[1]).value())); + } else { + return greaterThan( + unquote(predicate.children()[1].toString()), + convertUTF8StringIfNecessary(((LiteralValue) predicate.children()[0]).value())); + } + + case LT_EQ: + if (predicate.children()[1] instanceof LiteralValue) { + return lessThanOrEqual( + unquote(predicate.children()[0].toString()), + convertUTF8StringIfNecessary(((LiteralValue) predicate.children()[1]).value())); + } else { + return greaterThanOrEqual( + unquote(predicate.children()[1].toString()), + convertUTF8StringIfNecessary(((LiteralValue) predicate.children()[0]).value())); + } + + case GT: + if (predicate.children()[1] instanceof LiteralValue) { + return greaterThan( + unquote(predicate.children()[0].toString()), + convertUTF8StringIfNecessary(((LiteralValue) predicate.children()[1]).value())); + } else { + return lessThan( + unquote(predicate.children()[1].toString()), + convertUTF8StringIfNecessary(((LiteralValue) predicate.children()[0]).value())); + } + + case GT_EQ: + if (predicate.children()[1] instanceof LiteralValue) { + return greaterThanOrEqual( + unquote(predicate.children()[0].toString()), + convertUTF8StringIfNecessary(((LiteralValue) predicate.children()[1]).value())); + } else { + return lessThanOrEqual( + unquote(predicate.children()[1].toString()), + convertUTF8StringIfNecessary(((LiteralValue) predicate.children()[0]).value())); + } + + case EQ: // used for both eq and null-safe-eq + Object value = null; Review Comment: Nit: looks like we dont need null and "" (java defaults) ########## spark/v3.3/spark/src/main/java/org/apache/iceberg/spark/SparkV2Filters.java: ########## @@ -0,0 +1,375 @@ +/* + * 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.iceberg.spark; + +import static org.apache.iceberg.expressions.Expressions.and; +import static org.apache.iceberg.expressions.Expressions.equal; +import static org.apache.iceberg.expressions.Expressions.greaterThan; +import static org.apache.iceberg.expressions.Expressions.greaterThanOrEqual; +import static org.apache.iceberg.expressions.Expressions.in; +import static org.apache.iceberg.expressions.Expressions.isNaN; +import static org.apache.iceberg.expressions.Expressions.isNull; +import static org.apache.iceberg.expressions.Expressions.lessThan; +import static org.apache.iceberg.expressions.Expressions.lessThanOrEqual; +import static org.apache.iceberg.expressions.Expressions.not; +import static org.apache.iceberg.expressions.Expressions.notIn; +import static org.apache.iceberg.expressions.Expressions.notNull; +import static org.apache.iceberg.expressions.Expressions.or; +import static org.apache.iceberg.expressions.Expressions.startsWith; + +import java.util.Map; +import java.util.Objects; +import java.util.regex.Matcher; +import java.util.regex.Pattern; +import java.util.stream.Collectors; +import java.util.stream.Stream; +import org.apache.iceberg.expressions.Expression; +import org.apache.iceberg.expressions.Expressions; +import org.apache.iceberg.relocated.com.google.common.base.Preconditions; +import org.apache.iceberg.relocated.com.google.common.collect.ImmutableMap; +import org.apache.iceberg.util.NaNUtil; +import org.apache.spark.sql.connector.expressions.LiteralValue; +import org.apache.spark.sql.connector.expressions.NamedReference; +import org.apache.spark.sql.connector.expressions.filter.And; +import org.apache.spark.sql.connector.expressions.filter.Not; +import org.apache.spark.sql.connector.expressions.filter.Or; +import org.apache.spark.sql.connector.expressions.filter.Predicate; +import org.apache.spark.unsafe.types.UTF8String; + +public class SparkV2Filters { + + private static final Pattern BACKTICKS_PATTERN = Pattern.compile("([`])(.|$)"); + + private SparkV2Filters() {} + + private static final Map<String, Expression.Operation> FILTERS = + ImmutableMap.<String, Expression.Operation>builder() + .put("ALWAYS_TRUE", Expression.Operation.TRUE) + .put("ALWAYS_FALSE", Expression.Operation.FALSE) + .put("=", Expression.Operation.EQ) + .put("<=>", Expression.Operation.EQ) + .put(">", Expression.Operation.GT) + .put(">=", Expression.Operation.GT_EQ) + .put("<", Expression.Operation.LT) + .put("<=", Expression.Operation.LT_EQ) + .put("IN", Expression.Operation.IN) + .put("IS_NULL", Expression.Operation.IS_NULL) + .put("IS_NOT_NULL", Expression.Operation.NOT_NULL) + .put("AND", Expression.Operation.AND) + .put("OR", Expression.Operation.OR) + .put("NOT", Expression.Operation.NOT) + .put("STARTS_WITH", Expression.Operation.STARTS_WITH) + .build(); + + public static Expression convert(Predicate[] predicates) { + Expression expression = Expressions.alwaysTrue(); + for (Predicate predicate : predicates) { + Expression converted = convert(predicate); + Preconditions.checkArgument( + converted != null, "Cannot convert predicate to Iceberg: %s", predicate); + expression = Expressions.and(expression, converted); + } + return expression; + } + + @SuppressWarnings({"checkstyle:CyclomaticComplexity", "checkstyle:MethodLength"}) + public static Expression convert(Predicate predicate) { + if (checkIfPredicateValid(predicate) == null) { + return null; + } + + Expression.Operation op = FILTERS.get(predicate.name()); + if (op != null) { + switch (op) { + case TRUE: + return Expressions.alwaysTrue(); + + case FALSE: + return Expressions.alwaysFalse(); + + case IS_NULL: + return isNull(unquote(predicate.children()[0].toString())); + + case NOT_NULL: + return notNull(unquote(predicate.children()[0].toString())); + + case LT: + if (predicate.children()[1] instanceof LiteralValue) { + return lessThan( + unquote(predicate.children()[0].toString()), + convertUTF8StringIfNecessary(((LiteralValue) predicate.children()[1]).value())); + } else { + return greaterThan( + unquote(predicate.children()[1].toString()), + convertUTF8StringIfNecessary(((LiteralValue) predicate.children()[0]).value())); + } + + case LT_EQ: + if (predicate.children()[1] instanceof LiteralValue) { + return lessThanOrEqual( + unquote(predicate.children()[0].toString()), + convertUTF8StringIfNecessary(((LiteralValue) predicate.children()[1]).value())); + } else { + return greaterThanOrEqual( + unquote(predicate.children()[1].toString()), + convertUTF8StringIfNecessary(((LiteralValue) predicate.children()[0]).value())); + } + + case GT: + if (predicate.children()[1] instanceof LiteralValue) { + return greaterThan( + unquote(predicate.children()[0].toString()), + convertUTF8StringIfNecessary(((LiteralValue) predicate.children()[1]).value())); + } else { + return lessThan( + unquote(predicate.children()[1].toString()), + convertUTF8StringIfNecessary(((LiteralValue) predicate.children()[0]).value())); + } + + case GT_EQ: + if (predicate.children()[1] instanceof LiteralValue) { + return greaterThanOrEqual( + unquote(predicate.children()[0].toString()), + convertUTF8StringIfNecessary(((LiteralValue) predicate.children()[1]).value())); + } else { + return lessThanOrEqual( + unquote(predicate.children()[1].toString()), + convertUTF8StringIfNecessary(((LiteralValue) predicate.children()[0]).value())); + } + + case EQ: // used for both eq and null-safe-eq + Object value = null; + String attributeName = ""; + if (predicate.children()[1] instanceof LiteralValue) { + attributeName = predicate.children()[0].toString(); + value = convertUTF8StringIfNecessary(((LiteralValue) predicate.children()[1]).value()); + } else { + attributeName = predicate.children()[1].toString(); + value = convertUTF8StringIfNecessary(((LiteralValue) predicate.children()[0]).value()); + } + + if (predicate.name().equals("=")) { + // comparison with null in normal equality is always null. this is probably a mistake. + Preconditions.checkNotNull( + value, "Expression is always false (eq is not null-safe): %s", predicate); + return handleEqual(unquote(attributeName), value); + } else if (predicate.name().equals("<=>")) { + if (value == null) { + return isNull(unquote(attributeName)); + } else { + return handleEqual(unquote(attributeName), value); + } + } + break; + + case IN: + Object[] inValues = new Object[predicate.children().length - 1]; + for (int i = 1; i < predicate.children().length; i++) { + inValues[i - 1] = + convertUTF8StringIfNecessary(((LiteralValue) predicate.children()[i]).value()); + } + return in( + unquote(predicate.children()[0].toString()), + Stream.of(inValues).filter(Objects::nonNull).collect(Collectors.toList())); + + case NOT: + Not notFilter = (Not) predicate; + Predicate childFilter = notFilter.child(); + if (childFilter.name().equals("IN")) { + // infer an extra notNull predicate for Spark NOT IN filters + // as Iceberg expressions don't follow the 3-value SQL boolean logic + // col NOT IN (1, 2) in Spark is equivalent to notNull(col) && notIn(col, 1, 2) in + // Iceberg + Object[] notInValues = new Object[childFilter.children().length - 1]; + for (int i = 1; i < childFilter.children().length; i++) { + notInValues[i - 1] = + convertUTF8StringIfNecessary(((LiteralValue) childFilter.children()[i]).value()); + } + Expression notIn = + notIn( + unquote(childFilter.children()[0].toString()), + Stream.of(notInValues).collect(Collectors.toList())); + return and(notNull(unquote(childFilter.children()[0].toString())), notIn); + } else if (hasNoInFilter(childFilter)) { + Expression child = convert(childFilter); + if (child != null) { + return not(child); + } + } + return null; + + case AND: + { + And andPredicate = (And) predicate; + Expression left = convert(andPredicate.left()); + Expression right = convert(andPredicate.right()); + if (left != null && right != null) { + return and(left, right); + } + return null; + } + + case OR: + { + Or orPredicate = (Or) predicate; + Expression left = convert(orPredicate.left()); + Expression right = convert(orPredicate.right()); + if (left != null && right != null) { + return or(left, right); + } + return null; + } + + case STARTS_WITH: + { + return startsWith( + unquote(predicate.children()[0].toString()), + convertUTF8StringIfNecessary(((LiteralValue) predicate.children()[1]).value()) + .toString()); + } + } + } + + return null; + } + + private static Object convertUTF8StringIfNecessary(Object value) { + if (value instanceof UTF8String) { + return ((UTF8String) value).toString(); + } + return value; + } + + private static Expression handleEqual(String attribute, Object value) { + if (NaNUtil.isNaN(value)) { + return isNaN(attribute); + } else { + return equal(attribute, value); + } + } + + private static String unquote(String attributeName) { + Matcher matcher = BACKTICKS_PATTERN.matcher(attributeName); + return matcher.replaceAll("$2"); + } + + private static boolean hasNoInFilter(Predicate predicate) { + Expression.Operation op = FILTERS.get(predicate.name()); + + if (op != null) { + switch (op) { + case AND: + And andPredicate = (And) predicate; + return hasNoInFilter(andPredicate.left()) && hasNoInFilter(andPredicate.right()); + case OR: + Or orPredicate = (Or) predicate; + return hasNoInFilter(orPredicate.left()) && hasNoInFilter(orPredicate.right()); + case NOT: + Not notPredicate = (Not) predicate; + return hasNoInFilter(notPredicate.child()); + case IN: + return false; + default: + return true; + } + } + + return false; + } + + @SuppressWarnings("checkstyle:CyclomaticComplexity") + private static Predicate checkIfPredicateValid(Predicate predicate) { + Expression.Operation op = FILTERS.get(predicate.name()); + if (op != null) { + switch (op) { + case IS_NULL: + case NOT_NULL: + if (!(predicate.children()[0] instanceof NamedReference)) { + return null; + } + return predicate; + + case LT: + case LT_EQ: + case GT: + case GT_EQ: + case EQ: + if (predicate.children().length != 2 Review Comment: Just a personal preference but maybe its easier to read (if we go with the boolean return value approach): ``` if (predicate.children.length() != 2) { return false; } return (predicate.children[0] instanceof NamedReference && predicate.children[1] instanceof LiteralReference) || (predicate.children[0] instanceof LiteralRefernce && predicate.children[1] instanceof NamedReference]); ``` ########## spark/v3.3/spark/src/main/java/org/apache/iceberg/spark/SparkV2Filters.java: ########## @@ -0,0 +1,375 @@ +/* + * 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.iceberg.spark; + +import static org.apache.iceberg.expressions.Expressions.and; +import static org.apache.iceberg.expressions.Expressions.equal; +import static org.apache.iceberg.expressions.Expressions.greaterThan; +import static org.apache.iceberg.expressions.Expressions.greaterThanOrEqual; +import static org.apache.iceberg.expressions.Expressions.in; +import static org.apache.iceberg.expressions.Expressions.isNaN; +import static org.apache.iceberg.expressions.Expressions.isNull; +import static org.apache.iceberg.expressions.Expressions.lessThan; +import static org.apache.iceberg.expressions.Expressions.lessThanOrEqual; +import static org.apache.iceberg.expressions.Expressions.not; +import static org.apache.iceberg.expressions.Expressions.notIn; +import static org.apache.iceberg.expressions.Expressions.notNull; +import static org.apache.iceberg.expressions.Expressions.or; +import static org.apache.iceberg.expressions.Expressions.startsWith; + +import java.util.Map; +import java.util.Objects; +import java.util.regex.Matcher; +import java.util.regex.Pattern; +import java.util.stream.Collectors; +import java.util.stream.Stream; +import org.apache.iceberg.expressions.Expression; +import org.apache.iceberg.expressions.Expressions; +import org.apache.iceberg.relocated.com.google.common.base.Preconditions; +import org.apache.iceberg.relocated.com.google.common.collect.ImmutableMap; +import org.apache.iceberg.util.NaNUtil; +import org.apache.spark.sql.connector.expressions.LiteralValue; +import org.apache.spark.sql.connector.expressions.NamedReference; +import org.apache.spark.sql.connector.expressions.filter.And; +import org.apache.spark.sql.connector.expressions.filter.Not; +import org.apache.spark.sql.connector.expressions.filter.Or; +import org.apache.spark.sql.connector.expressions.filter.Predicate; +import org.apache.spark.unsafe.types.UTF8String; + +public class SparkV2Filters { + + private static final Pattern BACKTICKS_PATTERN = Pattern.compile("([`])(.|$)"); + + private SparkV2Filters() {} + + private static final Map<String, Expression.Operation> FILTERS = + ImmutableMap.<String, Expression.Operation>builder() + .put("ALWAYS_TRUE", Expression.Operation.TRUE) + .put("ALWAYS_FALSE", Expression.Operation.FALSE) + .put("=", Expression.Operation.EQ) + .put("<=>", Expression.Operation.EQ) + .put(">", Expression.Operation.GT) + .put(">=", Expression.Operation.GT_EQ) + .put("<", Expression.Operation.LT) + .put("<=", Expression.Operation.LT_EQ) + .put("IN", Expression.Operation.IN) + .put("IS_NULL", Expression.Operation.IS_NULL) + .put("IS_NOT_NULL", Expression.Operation.NOT_NULL) + .put("AND", Expression.Operation.AND) + .put("OR", Expression.Operation.OR) + .put("NOT", Expression.Operation.NOT) + .put("STARTS_WITH", Expression.Operation.STARTS_WITH) + .build(); + + public static Expression convert(Predicate[] predicates) { + Expression expression = Expressions.alwaysTrue(); + for (Predicate predicate : predicates) { + Expression converted = convert(predicate); + Preconditions.checkArgument( + converted != null, "Cannot convert predicate to Iceberg: %s", predicate); + expression = Expressions.and(expression, converted); + } + return expression; + } + + @SuppressWarnings({"checkstyle:CyclomaticComplexity", "checkstyle:MethodLength"}) + public static Expression convert(Predicate predicate) { + if (checkIfPredicateValid(predicate) == null) { + return null; + } + + Expression.Operation op = FILTERS.get(predicate.name()); + if (op != null) { + switch (op) { + case TRUE: + return Expressions.alwaysTrue(); + + case FALSE: + return Expressions.alwaysFalse(); + + case IS_NULL: + return isNull(unquote(predicate.children()[0].toString())); + + case NOT_NULL: + return notNull(unquote(predicate.children()[0].toString())); + + case LT: + if (predicate.children()[1] instanceof LiteralValue) { + return lessThan( + unquote(predicate.children()[0].toString()), + convertUTF8StringIfNecessary(((LiteralValue) predicate.children()[1]).value())); + } else { + return greaterThan( + unquote(predicate.children()[1].toString()), + convertUTF8StringIfNecessary(((LiteralValue) predicate.children()[0]).value())); + } + + case LT_EQ: + if (predicate.children()[1] instanceof LiteralValue) { + return lessThanOrEqual( + unquote(predicate.children()[0].toString()), + convertUTF8StringIfNecessary(((LiteralValue) predicate.children()[1]).value())); + } else { + return greaterThanOrEqual( + unquote(predicate.children()[1].toString()), + convertUTF8StringIfNecessary(((LiteralValue) predicate.children()[0]).value())); + } + + case GT: + if (predicate.children()[1] instanceof LiteralValue) { + return greaterThan( + unquote(predicate.children()[0].toString()), + convertUTF8StringIfNecessary(((LiteralValue) predicate.children()[1]).value())); + } else { + return lessThan( + unquote(predicate.children()[1].toString()), + convertUTF8StringIfNecessary(((LiteralValue) predicate.children()[0]).value())); + } + + case GT_EQ: + if (predicate.children()[1] instanceof LiteralValue) { + return greaterThanOrEqual( + unquote(predicate.children()[0].toString()), + convertUTF8StringIfNecessary(((LiteralValue) predicate.children()[1]).value())); + } else { + return lessThanOrEqual( + unquote(predicate.children()[1].toString()), + convertUTF8StringIfNecessary(((LiteralValue) predicate.children()[0]).value())); + } + + case EQ: // used for both eq and null-safe-eq + Object value = null; + String attributeName = ""; + if (predicate.children()[1] instanceof LiteralValue) { + attributeName = predicate.children()[0].toString(); + value = convertUTF8StringIfNecessary(((LiteralValue) predicate.children()[1]).value()); + } else { + attributeName = predicate.children()[1].toString(); + value = convertUTF8StringIfNecessary(((LiteralValue) predicate.children()[0]).value()); + } + + if (predicate.name().equals("=")) { + // comparison with null in normal equality is always null. this is probably a mistake. + Preconditions.checkNotNull( + value, "Expression is always false (eq is not null-safe): %s", predicate); + return handleEqual(unquote(attributeName), value); + } else if (predicate.name().equals("<=>")) { + if (value == null) { + return isNull(unquote(attributeName)); + } else { + return handleEqual(unquote(attributeName), value); + } + } + break; + + case IN: + Object[] inValues = new Object[predicate.children().length - 1]; + for (int i = 1; i < predicate.children().length; i++) { + inValues[i - 1] = + convertUTF8StringIfNecessary(((LiteralValue) predicate.children()[i]).value()); + } + return in( + unquote(predicate.children()[0].toString()), + Stream.of(inValues).filter(Objects::nonNull).collect(Collectors.toList())); + + case NOT: + Not notFilter = (Not) predicate; + Predicate childFilter = notFilter.child(); + if (childFilter.name().equals("IN")) { + // infer an extra notNull predicate for Spark NOT IN filters + // as Iceberg expressions don't follow the 3-value SQL boolean logic + // col NOT IN (1, 2) in Spark is equivalent to notNull(col) && notIn(col, 1, 2) in + // Iceberg + Object[] notInValues = new Object[childFilter.children().length - 1]; + for (int i = 1; i < childFilter.children().length; i++) { + notInValues[i - 1] = + convertUTF8StringIfNecessary(((LiteralValue) childFilter.children()[i]).value()); + } + Expression notIn = + notIn( + unquote(childFilter.children()[0].toString()), + Stream.of(notInValues).collect(Collectors.toList())); + return and(notNull(unquote(childFilter.children()[0].toString())), notIn); + } else if (hasNoInFilter(childFilter)) { + Expression child = convert(childFilter); + if (child != null) { + return not(child); + } + } + return null; + + case AND: + { + And andPredicate = (And) predicate; + Expression left = convert(andPredicate.left()); + Expression right = convert(andPredicate.right()); + if (left != null && right != null) { + return and(left, right); + } + return null; + } + + case OR: + { + Or orPredicate = (Or) predicate; + Expression left = convert(orPredicate.left()); + Expression right = convert(orPredicate.right()); + if (left != null && right != null) { + return or(left, right); + } + return null; + } + + case STARTS_WITH: + { + return startsWith( + unquote(predicate.children()[0].toString()), + convertUTF8StringIfNecessary(((LiteralValue) predicate.children()[1]).value()) + .toString()); + } + } + } + + return null; + } + + private static Object convertUTF8StringIfNecessary(Object value) { + if (value instanceof UTF8String) { + return ((UTF8String) value).toString(); + } + return value; + } + + private static Expression handleEqual(String attribute, Object value) { + if (NaNUtil.isNaN(value)) { + return isNaN(attribute); + } else { + return equal(attribute, value); + } + } + + private static String unquote(String attributeName) { + Matcher matcher = BACKTICKS_PATTERN.matcher(attributeName); + return matcher.replaceAll("$2"); + } + + private static boolean hasNoInFilter(Predicate predicate) { + Expression.Operation op = FILTERS.get(predicate.name()); + + if (op != null) { + switch (op) { + case AND: + And andPredicate = (And) predicate; + return hasNoInFilter(andPredicate.left()) && hasNoInFilter(andPredicate.right()); + case OR: + Or orPredicate = (Or) predicate; + return hasNoInFilter(orPredicate.left()) && hasNoInFilter(orPredicate.right()); + case NOT: + Not notPredicate = (Not) predicate; + return hasNoInFilter(notPredicate.child()); + case IN: + return false; + default: + return true; + } + } + + return false; + } + + @SuppressWarnings("checkstyle:CyclomaticComplexity") + private static Predicate checkIfPredicateValid(Predicate predicate) { + Expression.Operation op = FILTERS.get(predicate.name()); + if (op != null) { + switch (op) { + case IS_NULL: + case NOT_NULL: + if (!(predicate.children()[0] instanceof NamedReference)) { + return null; + } + return predicate; + + case LT: + case LT_EQ: + case GT: + case GT_EQ: + case EQ: + if (predicate.children().length != 2 + || !(((predicate.children()[1] instanceof LiteralValue + && predicate.children()[0] instanceof NamedReference)) + || ((predicate.children()[0] instanceof LiteralValue + && predicate.children()[1] instanceof NamedReference)))) { + return null; + } + return predicate; + + case IN: + if (!(predicate.children()[0] instanceof NamedReference)) { + return null; + } else { + for (int i = 1; i < predicate.children().length; i++) { + if (!(predicate.children()[i] instanceof LiteralValue)) { + return null; + } + } + return predicate; + } + + case NOT: + Not notFilter = (Not) predicate; + return checkIfPredicateValid(notFilter.child()); + + case AND: + And andFilter = (And) predicate; + if (checkIfPredicateValid(andFilter.left()) == null Review Comment: Same if we change, we could have an easier to read: return valid(andFilter.left) && valid(andFilter.right); ########## spark/v3.3/spark/src/main/java/org/apache/iceberg/spark/SparkV2Filters.java: ########## @@ -0,0 +1,375 @@ +/* + * 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.iceberg.spark; + +import static org.apache.iceberg.expressions.Expressions.and; +import static org.apache.iceberg.expressions.Expressions.equal; +import static org.apache.iceberg.expressions.Expressions.greaterThan; +import static org.apache.iceberg.expressions.Expressions.greaterThanOrEqual; +import static org.apache.iceberg.expressions.Expressions.in; +import static org.apache.iceberg.expressions.Expressions.isNaN; +import static org.apache.iceberg.expressions.Expressions.isNull; +import static org.apache.iceberg.expressions.Expressions.lessThan; +import static org.apache.iceberg.expressions.Expressions.lessThanOrEqual; +import static org.apache.iceberg.expressions.Expressions.not; +import static org.apache.iceberg.expressions.Expressions.notIn; +import static org.apache.iceberg.expressions.Expressions.notNull; +import static org.apache.iceberg.expressions.Expressions.or; +import static org.apache.iceberg.expressions.Expressions.startsWith; + +import java.util.Map; +import java.util.Objects; +import java.util.regex.Matcher; +import java.util.regex.Pattern; +import java.util.stream.Collectors; +import java.util.stream.Stream; +import org.apache.iceberg.expressions.Expression; +import org.apache.iceberg.expressions.Expressions; +import org.apache.iceberg.relocated.com.google.common.base.Preconditions; +import org.apache.iceberg.relocated.com.google.common.collect.ImmutableMap; +import org.apache.iceberg.util.NaNUtil; +import org.apache.spark.sql.connector.expressions.LiteralValue; +import org.apache.spark.sql.connector.expressions.NamedReference; +import org.apache.spark.sql.connector.expressions.filter.And; +import org.apache.spark.sql.connector.expressions.filter.Not; +import org.apache.spark.sql.connector.expressions.filter.Or; +import org.apache.spark.sql.connector.expressions.filter.Predicate; +import org.apache.spark.unsafe.types.UTF8String; + +public class SparkV2Filters { + + private static final Pattern BACKTICKS_PATTERN = Pattern.compile("([`])(.|$)"); + + private SparkV2Filters() {} + + private static final Map<String, Expression.Operation> FILTERS = + ImmutableMap.<String, Expression.Operation>builder() + .put("ALWAYS_TRUE", Expression.Operation.TRUE) + .put("ALWAYS_FALSE", Expression.Operation.FALSE) + .put("=", Expression.Operation.EQ) + .put("<=>", Expression.Operation.EQ) + .put(">", Expression.Operation.GT) + .put(">=", Expression.Operation.GT_EQ) + .put("<", Expression.Operation.LT) + .put("<=", Expression.Operation.LT_EQ) + .put("IN", Expression.Operation.IN) + .put("IS_NULL", Expression.Operation.IS_NULL) + .put("IS_NOT_NULL", Expression.Operation.NOT_NULL) + .put("AND", Expression.Operation.AND) + .put("OR", Expression.Operation.OR) + .put("NOT", Expression.Operation.NOT) + .put("STARTS_WITH", Expression.Operation.STARTS_WITH) + .build(); + + public static Expression convert(Predicate[] predicates) { + Expression expression = Expressions.alwaysTrue(); + for (Predicate predicate : predicates) { + Expression converted = convert(predicate); + Preconditions.checkArgument( + converted != null, "Cannot convert predicate to Iceberg: %s", predicate); + expression = Expressions.and(expression, converted); + } + return expression; + } + + @SuppressWarnings({"checkstyle:CyclomaticComplexity", "checkstyle:MethodLength"}) + public static Expression convert(Predicate predicate) { + if (checkIfPredicateValid(predicate) == null) { + return null; + } + + Expression.Operation op = FILTERS.get(predicate.name()); + if (op != null) { + switch (op) { + case TRUE: + return Expressions.alwaysTrue(); + + case FALSE: + return Expressions.alwaysFalse(); + + case IS_NULL: + return isNull(unquote(predicate.children()[0].toString())); + + case NOT_NULL: + return notNull(unquote(predicate.children()[0].toString())); + + case LT: + if (predicate.children()[1] instanceof LiteralValue) { + return lessThan( + unquote(predicate.children()[0].toString()), + convertUTF8StringIfNecessary(((LiteralValue) predicate.children()[1]).value())); + } else { + return greaterThan( + unquote(predicate.children()[1].toString()), + convertUTF8StringIfNecessary(((LiteralValue) predicate.children()[0]).value())); + } + + case LT_EQ: + if (predicate.children()[1] instanceof LiteralValue) { + return lessThanOrEqual( + unquote(predicate.children()[0].toString()), + convertUTF8StringIfNecessary(((LiteralValue) predicate.children()[1]).value())); + } else { + return greaterThanOrEqual( + unquote(predicate.children()[1].toString()), + convertUTF8StringIfNecessary(((LiteralValue) predicate.children()[0]).value())); + } + + case GT: + if (predicate.children()[1] instanceof LiteralValue) { + return greaterThan( + unquote(predicate.children()[0].toString()), + convertUTF8StringIfNecessary(((LiteralValue) predicate.children()[1]).value())); + } else { + return lessThan( + unquote(predicate.children()[1].toString()), + convertUTF8StringIfNecessary(((LiteralValue) predicate.children()[0]).value())); + } + + case GT_EQ: + if (predicate.children()[1] instanceof LiteralValue) { + return greaterThanOrEqual( + unquote(predicate.children()[0].toString()), + convertUTF8StringIfNecessary(((LiteralValue) predicate.children()[1]).value())); + } else { + return lessThanOrEqual( + unquote(predicate.children()[1].toString()), + convertUTF8StringIfNecessary(((LiteralValue) predicate.children()[0]).value())); + } + + case EQ: // used for both eq and null-safe-eq + Object value = null; + String attributeName = ""; + if (predicate.children()[1] instanceof LiteralValue) { + attributeName = predicate.children()[0].toString(); + value = convertUTF8StringIfNecessary(((LiteralValue) predicate.children()[1]).value()); + } else { + attributeName = predicate.children()[1].toString(); + value = convertUTF8StringIfNecessary(((LiteralValue) predicate.children()[0]).value()); + } + + if (predicate.name().equals("=")) { + // comparison with null in normal equality is always null. this is probably a mistake. + Preconditions.checkNotNull( + value, "Expression is always false (eq is not null-safe): %s", predicate); + return handleEqual(unquote(attributeName), value); + } else if (predicate.name().equals("<=>")) { + if (value == null) { + return isNull(unquote(attributeName)); + } else { + return handleEqual(unquote(attributeName), value); + } + } + break; + + case IN: + Object[] inValues = new Object[predicate.children().length - 1]; + for (int i = 1; i < predicate.children().length; i++) { Review Comment: Why not just make this a stream (as the next line anyway converts it to stream). Ie, predicate.children.stream().map(c -> convertUTF8StringIfNecessary(...)) ########## spark/v3.3/spark/src/main/java/org/apache/iceberg/spark/SparkV2Filters.java: ########## @@ -0,0 +1,375 @@ +/* + * 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.iceberg.spark; + +import static org.apache.iceberg.expressions.Expressions.and; +import static org.apache.iceberg.expressions.Expressions.equal; +import static org.apache.iceberg.expressions.Expressions.greaterThan; +import static org.apache.iceberg.expressions.Expressions.greaterThanOrEqual; +import static org.apache.iceberg.expressions.Expressions.in; +import static org.apache.iceberg.expressions.Expressions.isNaN; +import static org.apache.iceberg.expressions.Expressions.isNull; +import static org.apache.iceberg.expressions.Expressions.lessThan; +import static org.apache.iceberg.expressions.Expressions.lessThanOrEqual; +import static org.apache.iceberg.expressions.Expressions.not; +import static org.apache.iceberg.expressions.Expressions.notIn; +import static org.apache.iceberg.expressions.Expressions.notNull; +import static org.apache.iceberg.expressions.Expressions.or; +import static org.apache.iceberg.expressions.Expressions.startsWith; + +import java.util.Map; +import java.util.Objects; +import java.util.regex.Matcher; +import java.util.regex.Pattern; +import java.util.stream.Collectors; +import java.util.stream.Stream; +import org.apache.iceberg.expressions.Expression; +import org.apache.iceberg.expressions.Expressions; +import org.apache.iceberg.relocated.com.google.common.base.Preconditions; +import org.apache.iceberg.relocated.com.google.common.collect.ImmutableMap; +import org.apache.iceberg.util.NaNUtil; +import org.apache.spark.sql.connector.expressions.LiteralValue; +import org.apache.spark.sql.connector.expressions.NamedReference; +import org.apache.spark.sql.connector.expressions.filter.And; +import org.apache.spark.sql.connector.expressions.filter.Not; +import org.apache.spark.sql.connector.expressions.filter.Or; +import org.apache.spark.sql.connector.expressions.filter.Predicate; +import org.apache.spark.unsafe.types.UTF8String; + +public class SparkV2Filters { + + private static final Pattern BACKTICKS_PATTERN = Pattern.compile("([`])(.|$)"); + + private SparkV2Filters() {} + + private static final Map<String, Expression.Operation> FILTERS = + ImmutableMap.<String, Expression.Operation>builder() + .put("ALWAYS_TRUE", Expression.Operation.TRUE) + .put("ALWAYS_FALSE", Expression.Operation.FALSE) + .put("=", Expression.Operation.EQ) + .put("<=>", Expression.Operation.EQ) + .put(">", Expression.Operation.GT) + .put(">=", Expression.Operation.GT_EQ) + .put("<", Expression.Operation.LT) + .put("<=", Expression.Operation.LT_EQ) + .put("IN", Expression.Operation.IN) + .put("IS_NULL", Expression.Operation.IS_NULL) + .put("IS_NOT_NULL", Expression.Operation.NOT_NULL) + .put("AND", Expression.Operation.AND) + .put("OR", Expression.Operation.OR) + .put("NOT", Expression.Operation.NOT) + .put("STARTS_WITH", Expression.Operation.STARTS_WITH) + .build(); + + public static Expression convert(Predicate[] predicates) { + Expression expression = Expressions.alwaysTrue(); + for (Predicate predicate : predicates) { + Expression converted = convert(predicate); + Preconditions.checkArgument( + converted != null, "Cannot convert predicate to Iceberg: %s", predicate); + expression = Expressions.and(expression, converted); + } + return expression; + } + + @SuppressWarnings({"checkstyle:CyclomaticComplexity", "checkstyle:MethodLength"}) + public static Expression convert(Predicate predicate) { + if (checkIfPredicateValid(predicate) == null) { + return null; + } + + Expression.Operation op = FILTERS.get(predicate.name()); + if (op != null) { + switch (op) { + case TRUE: + return Expressions.alwaysTrue(); + + case FALSE: + return Expressions.alwaysFalse(); + + case IS_NULL: + return isNull(unquote(predicate.children()[0].toString())); + + case NOT_NULL: + return notNull(unquote(predicate.children()[0].toString())); + + case LT: + if (predicate.children()[1] instanceof LiteralValue) { + return lessThan( + unquote(predicate.children()[0].toString()), + convertUTF8StringIfNecessary(((LiteralValue) predicate.children()[1]).value())); Review Comment: I'm not very familiar but In the old SparkFilters code there used to be a 'convertLiteral' functionality. Do we need that for literals? ########## spark/v3.3/spark/src/main/java/org/apache/iceberg/spark/SparkV2Filters.java: ########## @@ -0,0 +1,375 @@ +/* + * 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.iceberg.spark; + +import static org.apache.iceberg.expressions.Expressions.and; +import static org.apache.iceberg.expressions.Expressions.equal; +import static org.apache.iceberg.expressions.Expressions.greaterThan; +import static org.apache.iceberg.expressions.Expressions.greaterThanOrEqual; +import static org.apache.iceberg.expressions.Expressions.in; +import static org.apache.iceberg.expressions.Expressions.isNaN; +import static org.apache.iceberg.expressions.Expressions.isNull; +import static org.apache.iceberg.expressions.Expressions.lessThan; +import static org.apache.iceberg.expressions.Expressions.lessThanOrEqual; +import static org.apache.iceberg.expressions.Expressions.not; +import static org.apache.iceberg.expressions.Expressions.notIn; +import static org.apache.iceberg.expressions.Expressions.notNull; +import static org.apache.iceberg.expressions.Expressions.or; +import static org.apache.iceberg.expressions.Expressions.startsWith; + +import java.util.Map; +import java.util.Objects; +import java.util.regex.Matcher; +import java.util.regex.Pattern; +import java.util.stream.Collectors; +import java.util.stream.Stream; +import org.apache.iceberg.expressions.Expression; +import org.apache.iceberg.expressions.Expressions; +import org.apache.iceberg.relocated.com.google.common.base.Preconditions; +import org.apache.iceberg.relocated.com.google.common.collect.ImmutableMap; +import org.apache.iceberg.util.NaNUtil; +import org.apache.spark.sql.connector.expressions.LiteralValue; +import org.apache.spark.sql.connector.expressions.NamedReference; +import org.apache.spark.sql.connector.expressions.filter.And; +import org.apache.spark.sql.connector.expressions.filter.Not; +import org.apache.spark.sql.connector.expressions.filter.Or; +import org.apache.spark.sql.connector.expressions.filter.Predicate; +import org.apache.spark.unsafe.types.UTF8String; + +public class SparkV2Filters { + + private static final Pattern BACKTICKS_PATTERN = Pattern.compile("([`])(.|$)"); + + private SparkV2Filters() {} + + private static final Map<String, Expression.Operation> FILTERS = + ImmutableMap.<String, Expression.Operation>builder() + .put("ALWAYS_TRUE", Expression.Operation.TRUE) + .put("ALWAYS_FALSE", Expression.Operation.FALSE) + .put("=", Expression.Operation.EQ) + .put("<=>", Expression.Operation.EQ) + .put(">", Expression.Operation.GT) + .put(">=", Expression.Operation.GT_EQ) + .put("<", Expression.Operation.LT) + .put("<=", Expression.Operation.LT_EQ) + .put("IN", Expression.Operation.IN) + .put("IS_NULL", Expression.Operation.IS_NULL) + .put("IS_NOT_NULL", Expression.Operation.NOT_NULL) + .put("AND", Expression.Operation.AND) + .put("OR", Expression.Operation.OR) + .put("NOT", Expression.Operation.NOT) + .put("STARTS_WITH", Expression.Operation.STARTS_WITH) + .build(); + + public static Expression convert(Predicate[] predicates) { + Expression expression = Expressions.alwaysTrue(); + for (Predicate predicate : predicates) { + Expression converted = convert(predicate); + Preconditions.checkArgument( + converted != null, "Cannot convert predicate to Iceberg: %s", predicate); + expression = Expressions.and(expression, converted); + } + return expression; + } + + @SuppressWarnings({"checkstyle:CyclomaticComplexity", "checkstyle:MethodLength"}) + public static Expression convert(Predicate predicate) { + if (checkIfPredicateValid(predicate) == null) { + return null; + } + + Expression.Operation op = FILTERS.get(predicate.name()); + if (op != null) { + switch (op) { + case TRUE: + return Expressions.alwaysTrue(); + + case FALSE: + return Expressions.alwaysFalse(); + + case IS_NULL: + return isNull(unquote(predicate.children()[0].toString())); + + case NOT_NULL: + return notNull(unquote(predicate.children()[0].toString())); + + case LT: + if (predicate.children()[1] instanceof LiteralValue) { + return lessThan( + unquote(predicate.children()[0].toString()), + convertUTF8StringIfNecessary(((LiteralValue) predicate.children()[1]).value())); + } else { + return greaterThan( + unquote(predicate.children()[1].toString()), + convertUTF8StringIfNecessary(((LiteralValue) predicate.children()[0]).value())); + } + + case LT_EQ: + if (predicate.children()[1] instanceof LiteralValue) { + return lessThanOrEqual( + unquote(predicate.children()[0].toString()), + convertUTF8StringIfNecessary(((LiteralValue) predicate.children()[1]).value())); + } else { + return greaterThanOrEqual( + unquote(predicate.children()[1].toString()), + convertUTF8StringIfNecessary(((LiteralValue) predicate.children()[0]).value())); + } + + case GT: + if (predicate.children()[1] instanceof LiteralValue) { + return greaterThan( + unquote(predicate.children()[0].toString()), + convertUTF8StringIfNecessary(((LiteralValue) predicate.children()[1]).value())); + } else { + return lessThan( + unquote(predicate.children()[1].toString()), + convertUTF8StringIfNecessary(((LiteralValue) predicate.children()[0]).value())); + } + + case GT_EQ: + if (predicate.children()[1] instanceof LiteralValue) { + return greaterThanOrEqual( + unquote(predicate.children()[0].toString()), + convertUTF8StringIfNecessary(((LiteralValue) predicate.children()[1]).value())); + } else { + return lessThanOrEqual( + unquote(predicate.children()[1].toString()), + convertUTF8StringIfNecessary(((LiteralValue) predicate.children()[0]).value())); + } + + case EQ: // used for both eq and null-safe-eq + Object value = null; + String attributeName = ""; + if (predicate.children()[1] instanceof LiteralValue) { + attributeName = predicate.children()[0].toString(); + value = convertUTF8StringIfNecessary(((LiteralValue) predicate.children()[1]).value()); + } else { + attributeName = predicate.children()[1].toString(); + value = convertUTF8StringIfNecessary(((LiteralValue) predicate.children()[0]).value()); + } + + if (predicate.name().equals("=")) { + // comparison with null in normal equality is always null. this is probably a mistake. + Preconditions.checkNotNull( + value, "Expression is always false (eq is not null-safe): %s", predicate); + return handleEqual(unquote(attributeName), value); + } else if (predicate.name().equals("<=>")) { + if (value == null) { + return isNull(unquote(attributeName)); + } else { + return handleEqual(unquote(attributeName), value); + } + } + break; + + case IN: + Object[] inValues = new Object[predicate.children().length - 1]; + for (int i = 1; i < predicate.children().length; i++) { + inValues[i - 1] = + convertUTF8StringIfNecessary(((LiteralValue) predicate.children()[i]).value()); + } + return in( + unquote(predicate.children()[0].toString()), + Stream.of(inValues).filter(Objects::nonNull).collect(Collectors.toList())); + + case NOT: + Not notFilter = (Not) predicate; + Predicate childFilter = notFilter.child(); + if (childFilter.name().equals("IN")) { + // infer an extra notNull predicate for Spark NOT IN filters + // as Iceberg expressions don't follow the 3-value SQL boolean logic + // col NOT IN (1, 2) in Spark is equivalent to notNull(col) && notIn(col, 1, 2) in + // Iceberg + Object[] notInValues = new Object[childFilter.children().length - 1]; + for (int i = 1; i < childFilter.children().length; i++) { + notInValues[i - 1] = + convertUTF8StringIfNecessary(((LiteralValue) childFilter.children()[i]).value()); + } + Expression notIn = + notIn( + unquote(childFilter.children()[0].toString()), + Stream.of(notInValues).collect(Collectors.toList())); + return and(notNull(unquote(childFilter.children()[0].toString())), notIn); + } else if (hasNoInFilter(childFilter)) { + Expression child = convert(childFilter); + if (child != null) { + return not(child); + } + } + return null; + + case AND: + { + And andPredicate = (And) predicate; + Expression left = convert(andPredicate.left()); + Expression right = convert(andPredicate.right()); + if (left != null && right != null) { + return and(left, right); + } + return null; + } + + case OR: + { + Or orPredicate = (Or) predicate; + Expression left = convert(orPredicate.left()); + Expression right = convert(orPredicate.right()); + if (left != null && right != null) { + return or(left, right); + } + return null; + } + + case STARTS_WITH: + { + return startsWith( + unquote(predicate.children()[0].toString()), + convertUTF8StringIfNecessary(((LiteralValue) predicate.children()[1]).value()) + .toString()); + } + } + } + + return null; + } + + private static Object convertUTF8StringIfNecessary(Object value) { + if (value instanceof UTF8String) { + return ((UTF8String) value).toString(); + } + return value; + } + + private static Expression handleEqual(String attribute, Object value) { + if (NaNUtil.isNaN(value)) { + return isNaN(attribute); + } else { + return equal(attribute, value); + } + } + + private static String unquote(String attributeName) { + Matcher matcher = BACKTICKS_PATTERN.matcher(attributeName); + return matcher.replaceAll("$2"); + } + + private static boolean hasNoInFilter(Predicate predicate) { + Expression.Operation op = FILTERS.get(predicate.name()); + + if (op != null) { + switch (op) { + case AND: + And andPredicate = (And) predicate; + return hasNoInFilter(andPredicate.left()) && hasNoInFilter(andPredicate.right()); + case OR: + Or orPredicate = (Or) predicate; + return hasNoInFilter(orPredicate.left()) && hasNoInFilter(orPredicate.right()); + case NOT: + Not notPredicate = (Not) predicate; + return hasNoInFilter(notPredicate.child()); + case IN: + return false; + default: + return true; + } + } + + return false; + } + + @SuppressWarnings("checkstyle:CyclomaticComplexity") + private static Predicate checkIfPredicateValid(Predicate predicate) { + Expression.Operation op = FILTERS.get(predicate.name()); + if (op != null) { + switch (op) { + case IS_NULL: + case NOT_NULL: + if (!(predicate.children()[0] instanceof NamedReference)) { + return null; + } + return predicate; + + case LT: + case LT_EQ: + case GT: + case GT_EQ: + case EQ: + if (predicate.children().length != 2 + || !(((predicate.children()[1] instanceof LiteralValue + && predicate.children()[0] instanceof NamedReference)) + || ((predicate.children()[0] instanceof LiteralValue + && predicate.children()[1] instanceof NamedReference)))) { + return null; + } + return predicate; + + case IN: + if (!(predicate.children()[0] instanceof NamedReference)) { + return null; + } else { + for (int i = 1; i < predicate.children().length; i++) { Review Comment: Also optional style suggestion, can use predicate.children.stream().allMatch() ########## spark/v3.3/spark/src/main/java/org/apache/iceberg/spark/SparkV2Filters.java: ########## @@ -0,0 +1,375 @@ +/* + * 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.iceberg.spark; + +import static org.apache.iceberg.expressions.Expressions.and; +import static org.apache.iceberg.expressions.Expressions.equal; +import static org.apache.iceberg.expressions.Expressions.greaterThan; +import static org.apache.iceberg.expressions.Expressions.greaterThanOrEqual; +import static org.apache.iceberg.expressions.Expressions.in; +import static org.apache.iceberg.expressions.Expressions.isNaN; +import static org.apache.iceberg.expressions.Expressions.isNull; +import static org.apache.iceberg.expressions.Expressions.lessThan; +import static org.apache.iceberg.expressions.Expressions.lessThanOrEqual; +import static org.apache.iceberg.expressions.Expressions.not; +import static org.apache.iceberg.expressions.Expressions.notIn; +import static org.apache.iceberg.expressions.Expressions.notNull; +import static org.apache.iceberg.expressions.Expressions.or; +import static org.apache.iceberg.expressions.Expressions.startsWith; + +import java.util.Map; +import java.util.Objects; +import java.util.regex.Matcher; +import java.util.regex.Pattern; +import java.util.stream.Collectors; +import java.util.stream.Stream; +import org.apache.iceberg.expressions.Expression; +import org.apache.iceberg.expressions.Expressions; +import org.apache.iceberg.relocated.com.google.common.base.Preconditions; +import org.apache.iceberg.relocated.com.google.common.collect.ImmutableMap; +import org.apache.iceberg.util.NaNUtil; +import org.apache.spark.sql.connector.expressions.LiteralValue; +import org.apache.spark.sql.connector.expressions.NamedReference; +import org.apache.spark.sql.connector.expressions.filter.And; +import org.apache.spark.sql.connector.expressions.filter.Not; +import org.apache.spark.sql.connector.expressions.filter.Or; +import org.apache.spark.sql.connector.expressions.filter.Predicate; +import org.apache.spark.unsafe.types.UTF8String; + +public class SparkV2Filters { + + private static final Pattern BACKTICKS_PATTERN = Pattern.compile("([`])(.|$)"); + + private SparkV2Filters() {} + + private static final Map<String, Expression.Operation> FILTERS = + ImmutableMap.<String, Expression.Operation>builder() + .put("ALWAYS_TRUE", Expression.Operation.TRUE) + .put("ALWAYS_FALSE", Expression.Operation.FALSE) + .put("=", Expression.Operation.EQ) + .put("<=>", Expression.Operation.EQ) + .put(">", Expression.Operation.GT) + .put(">=", Expression.Operation.GT_EQ) + .put("<", Expression.Operation.LT) + .put("<=", Expression.Operation.LT_EQ) + .put("IN", Expression.Operation.IN) + .put("IS_NULL", Expression.Operation.IS_NULL) + .put("IS_NOT_NULL", Expression.Operation.NOT_NULL) + .put("AND", Expression.Operation.AND) + .put("OR", Expression.Operation.OR) + .put("NOT", Expression.Operation.NOT) + .put("STARTS_WITH", Expression.Operation.STARTS_WITH) + .build(); + + public static Expression convert(Predicate[] predicates) { + Expression expression = Expressions.alwaysTrue(); + for (Predicate predicate : predicates) { + Expression converted = convert(predicate); + Preconditions.checkArgument( + converted != null, "Cannot convert predicate to Iceberg: %s", predicate); + expression = Expressions.and(expression, converted); + } + return expression; + } + + @SuppressWarnings({"checkstyle:CyclomaticComplexity", "checkstyle:MethodLength"}) + public static Expression convert(Predicate predicate) { + if (checkIfPredicateValid(predicate) == null) { + return null; + } + + Expression.Operation op = FILTERS.get(predicate.name()); + if (op != null) { + switch (op) { + case TRUE: + return Expressions.alwaysTrue(); + + case FALSE: + return Expressions.alwaysFalse(); + + case IS_NULL: + return isNull(unquote(predicate.children()[0].toString())); + + case NOT_NULL: + return notNull(unquote(predicate.children()[0].toString())); + + case LT: + if (predicate.children()[1] instanceof LiteralValue) { + return lessThan( + unquote(predicate.children()[0].toString()), + convertUTF8StringIfNecessary(((LiteralValue) predicate.children()[1]).value())); + } else { + return greaterThan( + unquote(predicate.children()[1].toString()), + convertUTF8StringIfNecessary(((LiteralValue) predicate.children()[0]).value())); + } + + case LT_EQ: + if (predicate.children()[1] instanceof LiteralValue) { + return lessThanOrEqual( + unquote(predicate.children()[0].toString()), + convertUTF8StringIfNecessary(((LiteralValue) predicate.children()[1]).value())); + } else { + return greaterThanOrEqual( + unquote(predicate.children()[1].toString()), + convertUTF8StringIfNecessary(((LiteralValue) predicate.children()[0]).value())); + } + + case GT: + if (predicate.children()[1] instanceof LiteralValue) { + return greaterThan( + unquote(predicate.children()[0].toString()), + convertUTF8StringIfNecessary(((LiteralValue) predicate.children()[1]).value())); + } else { + return lessThan( + unquote(predicate.children()[1].toString()), + convertUTF8StringIfNecessary(((LiteralValue) predicate.children()[0]).value())); + } + + case GT_EQ: + if (predicate.children()[1] instanceof LiteralValue) { + return greaterThanOrEqual( + unquote(predicate.children()[0].toString()), + convertUTF8StringIfNecessary(((LiteralValue) predicate.children()[1]).value())); + } else { + return lessThanOrEqual( + unquote(predicate.children()[1].toString()), + convertUTF8StringIfNecessary(((LiteralValue) predicate.children()[0]).value())); + } + + case EQ: // used for both eq and null-safe-eq + Object value = null; + String attributeName = ""; + if (predicate.children()[1] instanceof LiteralValue) { + attributeName = predicate.children()[0].toString(); + value = convertUTF8StringIfNecessary(((LiteralValue) predicate.children()[1]).value()); + } else { + attributeName = predicate.children()[1].toString(); + value = convertUTF8StringIfNecessary(((LiteralValue) predicate.children()[0]).value()); + } + + if (predicate.name().equals("=")) { + // comparison with null in normal equality is always null. this is probably a mistake. + Preconditions.checkNotNull( + value, "Expression is always false (eq is not null-safe): %s", predicate); + return handleEqual(unquote(attributeName), value); + } else if (predicate.name().equals("<=>")) { + if (value == null) { + return isNull(unquote(attributeName)); + } else { + return handleEqual(unquote(attributeName), value); + } + } + break; + + case IN: + Object[] inValues = new Object[predicate.children().length - 1]; + for (int i = 1; i < predicate.children().length; i++) { + inValues[i - 1] = + convertUTF8StringIfNecessary(((LiteralValue) predicate.children()[i]).value()); + } + return in( + unquote(predicate.children()[0].toString()), + Stream.of(inValues).filter(Objects::nonNull).collect(Collectors.toList())); + + case NOT: + Not notFilter = (Not) predicate; + Predicate childFilter = notFilter.child(); + if (childFilter.name().equals("IN")) { + // infer an extra notNull predicate for Spark NOT IN filters + // as Iceberg expressions don't follow the 3-value SQL boolean logic + // col NOT IN (1, 2) in Spark is equivalent to notNull(col) && notIn(col, 1, 2) in + // Iceberg + Object[] notInValues = new Object[childFilter.children().length - 1]; + for (int i = 1; i < childFilter.children().length; i++) { Review Comment: Same comment (use a stream) ########## spark/v3.3/spark/src/main/java/org/apache/iceberg/spark/SparkV2Filters.java: ########## @@ -0,0 +1,375 @@ +/* + * 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.iceberg.spark; + +import static org.apache.iceberg.expressions.Expressions.and; +import static org.apache.iceberg.expressions.Expressions.equal; +import static org.apache.iceberg.expressions.Expressions.greaterThan; +import static org.apache.iceberg.expressions.Expressions.greaterThanOrEqual; +import static org.apache.iceberg.expressions.Expressions.in; +import static org.apache.iceberg.expressions.Expressions.isNaN; +import static org.apache.iceberg.expressions.Expressions.isNull; +import static org.apache.iceberg.expressions.Expressions.lessThan; +import static org.apache.iceberg.expressions.Expressions.lessThanOrEqual; +import static org.apache.iceberg.expressions.Expressions.not; +import static org.apache.iceberg.expressions.Expressions.notIn; +import static org.apache.iceberg.expressions.Expressions.notNull; +import static org.apache.iceberg.expressions.Expressions.or; +import static org.apache.iceberg.expressions.Expressions.startsWith; + +import java.util.Map; +import java.util.Objects; +import java.util.regex.Matcher; +import java.util.regex.Pattern; +import java.util.stream.Collectors; +import java.util.stream.Stream; +import org.apache.iceberg.expressions.Expression; +import org.apache.iceberg.expressions.Expressions; +import org.apache.iceberg.relocated.com.google.common.base.Preconditions; +import org.apache.iceberg.relocated.com.google.common.collect.ImmutableMap; +import org.apache.iceberg.util.NaNUtil; +import org.apache.spark.sql.connector.expressions.LiteralValue; +import org.apache.spark.sql.connector.expressions.NamedReference; +import org.apache.spark.sql.connector.expressions.filter.And; +import org.apache.spark.sql.connector.expressions.filter.Not; +import org.apache.spark.sql.connector.expressions.filter.Or; +import org.apache.spark.sql.connector.expressions.filter.Predicate; +import org.apache.spark.unsafe.types.UTF8String; + +public class SparkV2Filters { + + private static final Pattern BACKTICKS_PATTERN = Pattern.compile("([`])(.|$)"); + + private SparkV2Filters() {} + + private static final Map<String, Expression.Operation> FILTERS = + ImmutableMap.<String, Expression.Operation>builder() + .put("ALWAYS_TRUE", Expression.Operation.TRUE) + .put("ALWAYS_FALSE", Expression.Operation.FALSE) + .put("=", Expression.Operation.EQ) + .put("<=>", Expression.Operation.EQ) + .put(">", Expression.Operation.GT) + .put(">=", Expression.Operation.GT_EQ) + .put("<", Expression.Operation.LT) + .put("<=", Expression.Operation.LT_EQ) + .put("IN", Expression.Operation.IN) + .put("IS_NULL", Expression.Operation.IS_NULL) + .put("IS_NOT_NULL", Expression.Operation.NOT_NULL) + .put("AND", Expression.Operation.AND) + .put("OR", Expression.Operation.OR) + .put("NOT", Expression.Operation.NOT) + .put("STARTS_WITH", Expression.Operation.STARTS_WITH) + .build(); + + public static Expression convert(Predicate[] predicates) { + Expression expression = Expressions.alwaysTrue(); + for (Predicate predicate : predicates) { + Expression converted = convert(predicate); + Preconditions.checkArgument( + converted != null, "Cannot convert predicate to Iceberg: %s", predicate); + expression = Expressions.and(expression, converted); + } + return expression; + } + + @SuppressWarnings({"checkstyle:CyclomaticComplexity", "checkstyle:MethodLength"}) + public static Expression convert(Predicate predicate) { + if (checkIfPredicateValid(predicate) == null) { + return null; + } + + Expression.Operation op = FILTERS.get(predicate.name()); + if (op != null) { + switch (op) { + case TRUE: + return Expressions.alwaysTrue(); + + case FALSE: + return Expressions.alwaysFalse(); + + case IS_NULL: + return isNull(unquote(predicate.children()[0].toString())); + + case NOT_NULL: + return notNull(unquote(predicate.children()[0].toString())); + + case LT: + if (predicate.children()[1] instanceof LiteralValue) { + return lessThan( + unquote(predicate.children()[0].toString()), + convertUTF8StringIfNecessary(((LiteralValue) predicate.children()[1]).value())); + } else { + return greaterThan( + unquote(predicate.children()[1].toString()), + convertUTF8StringIfNecessary(((LiteralValue) predicate.children()[0]).value())); + } + + case LT_EQ: + if (predicate.children()[1] instanceof LiteralValue) { + return lessThanOrEqual( + unquote(predicate.children()[0].toString()), + convertUTF8StringIfNecessary(((LiteralValue) predicate.children()[1]).value())); + } else { + return greaterThanOrEqual( + unquote(predicate.children()[1].toString()), + convertUTF8StringIfNecessary(((LiteralValue) predicate.children()[0]).value())); + } + + case GT: + if (predicate.children()[1] instanceof LiteralValue) { + return greaterThan( + unquote(predicate.children()[0].toString()), + convertUTF8StringIfNecessary(((LiteralValue) predicate.children()[1]).value())); + } else { + return lessThan( + unquote(predicate.children()[1].toString()), + convertUTF8StringIfNecessary(((LiteralValue) predicate.children()[0]).value())); + } + + case GT_EQ: + if (predicate.children()[1] instanceof LiteralValue) { + return greaterThanOrEqual( + unquote(predicate.children()[0].toString()), + convertUTF8StringIfNecessary(((LiteralValue) predicate.children()[1]).value())); + } else { + return lessThanOrEqual( + unquote(predicate.children()[1].toString()), + convertUTF8StringIfNecessary(((LiteralValue) predicate.children()[0]).value())); + } + + case EQ: // used for both eq and null-safe-eq + Object value = null; + String attributeName = ""; + if (predicate.children()[1] instanceof LiteralValue) { + attributeName = predicate.children()[0].toString(); + value = convertUTF8StringIfNecessary(((LiteralValue) predicate.children()[1]).value()); + } else { + attributeName = predicate.children()[1].toString(); + value = convertUTF8StringIfNecessary(((LiteralValue) predicate.children()[0]).value()); + } + + if (predicate.name().equals("=")) { + // comparison with null in normal equality is always null. this is probably a mistake. + Preconditions.checkNotNull( + value, "Expression is always false (eq is not null-safe): %s", predicate); + return handleEqual(unquote(attributeName), value); + } else if (predicate.name().equals("<=>")) { + if (value == null) { + return isNull(unquote(attributeName)); + } else { + return handleEqual(unquote(attributeName), value); + } + } + break; + + case IN: + Object[] inValues = new Object[predicate.children().length - 1]; + for (int i = 1; i < predicate.children().length; i++) { + inValues[i - 1] = + convertUTF8StringIfNecessary(((LiteralValue) predicate.children()[i]).value()); + } + return in( + unquote(predicate.children()[0].toString()), + Stream.of(inValues).filter(Objects::nonNull).collect(Collectors.toList())); + + case NOT: + Not notFilter = (Not) predicate; + Predicate childFilter = notFilter.child(); + if (childFilter.name().equals("IN")) { + // infer an extra notNull predicate for Spark NOT IN filters + // as Iceberg expressions don't follow the 3-value SQL boolean logic + // col NOT IN (1, 2) in Spark is equivalent to notNull(col) && notIn(col, 1, 2) in + // Iceberg + Object[] notInValues = new Object[childFilter.children().length - 1]; + for (int i = 1; i < childFilter.children().length; i++) { + notInValues[i - 1] = + convertUTF8StringIfNecessary(((LiteralValue) childFilter.children()[i]).value()); + } + Expression notIn = + notIn( + unquote(childFilter.children()[0].toString()), + Stream.of(notInValues).collect(Collectors.toList())); + return and(notNull(unquote(childFilter.children()[0].toString())), notIn); + } else if (hasNoInFilter(childFilter)) { + Expression child = convert(childFilter); + if (child != null) { + return not(child); + } + } + return null; + + case AND: + { + And andPredicate = (And) predicate; + Expression left = convert(andPredicate.left()); + Expression right = convert(andPredicate.right()); + if (left != null && right != null) { + return and(left, right); + } + return null; + } + + case OR: + { + Or orPredicate = (Or) predicate; + Expression left = convert(orPredicate.left()); + Expression right = convert(orPredicate.right()); + if (left != null && right != null) { + return or(left, right); + } + return null; + } + + case STARTS_WITH: + { + return startsWith( + unquote(predicate.children()[0].toString()), + convertUTF8StringIfNecessary(((LiteralValue) predicate.children()[1]).value()) + .toString()); + } + } + } + + return null; + } + + private static Object convertUTF8StringIfNecessary(Object value) { + if (value instanceof UTF8String) { + return ((UTF8String) value).toString(); + } + return value; + } + + private static Expression handleEqual(String attribute, Object value) { + if (NaNUtil.isNaN(value)) { + return isNaN(attribute); + } else { + return equal(attribute, value); + } + } + + private static String unquote(String attributeName) { + Matcher matcher = BACKTICKS_PATTERN.matcher(attributeName); + return matcher.replaceAll("$2"); + } + + private static boolean hasNoInFilter(Predicate predicate) { + Expression.Operation op = FILTERS.get(predicate.name()); + + if (op != null) { + switch (op) { + case AND: + And andPredicate = (And) predicate; + return hasNoInFilter(andPredicate.left()) && hasNoInFilter(andPredicate.right()); + case OR: + Or orPredicate = (Or) predicate; + return hasNoInFilter(orPredicate.left()) && hasNoInFilter(orPredicate.right()); + case NOT: + Not notPredicate = (Not) predicate; + return hasNoInFilter(notPredicate.child()); + case IN: + return false; + default: + return true; + } + } + + return false; + } + + @SuppressWarnings("checkstyle:CyclomaticComplexity") + private static Predicate checkIfPredicateValid(Predicate predicate) { Review Comment: I think we usually prefer shorter method names, so maybe valid(Predicate predicate) is better? Also, kind of related to the previous comment, why do we have the return value be a boolean instead of predicate? (valid seems to be a true/false question) -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
