rdblue commented on a change in pull request #32921: URL: https://github.com/apache/spark/pull/32921#discussion_r654632259
########## File path: sql/catalyst/src/main/java/org/apache/spark/sql/connector/read/SupportsDynamicFiltering.java ########## @@ -0,0 +1,55 @@ +/* + * 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.connector.read; + +import org.apache.spark.annotation.Experimental; +import org.apache.spark.sql.connector.expressions.NamedReference; +import org.apache.spark.sql.sources.Filter; + +/** + * A mix-in interface for {@link Scan}. Data sources can implement this interface if they can Review comment: Yeah, I agree with Wenchen. It is better to just state that Spark may use this to further refine the filters. ########## File path: sql/catalyst/src/main/java/org/apache/spark/sql/connector/read/SupportsDynamicFiltering.java ########## @@ -0,0 +1,55 @@ +/* + * 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.connector.read; + +import org.apache.spark.annotation.Experimental; +import org.apache.spark.sql.connector.expressions.NamedReference; +import org.apache.spark.sql.sources.Filter; + +/** + * A mix-in interface for {@link Scan}. Data sources can implement this interface if they can + * dynamically filter {@link InputPartition}s that were originally planned using predicates Review comment: @viirya, `InputPartition` is referring to Spark's partition, not a storage partition. These are actually tasks. This is another reason why Wenchen's suggestion is a good one. No need to mention what gets filtered or imply that you should produce `InputPartition` instances and then filter those. This only needs to state that additional filters may be added through this interface. ########## File path: sql/catalyst/src/main/java/org/apache/spark/sql/connector/read/SupportsDynamicFiltering.java ########## @@ -0,0 +1,55 @@ +/* + * 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.connector.read; + +import org.apache.spark.annotation.Experimental; +import org.apache.spark.sql.connector.expressions.NamedReference; +import org.apache.spark.sql.sources.Filter; + +/** + * A mix-in interface for {@link Scan}. Data sources can implement this interface if they can + * dynamically filter {@link InputPartition}s that were originally planned using predicates + * Spark infers by reusing parts of the query. + * + * @since 3.2.0 + */ +@Experimental +public interface SupportsDynamicFiltering extends Scan { + /** + * Returns attributes this scan can be dynamically filtered by. + * <p> + * Spark will call {@link #filter(Filter[])} if it can derive a dynamic + * predicate for any of the filter attributes. + */ + NamedReference[] filterAttributes(); + + /** + * Dynamically filters this scan. + * <p> + * The provided expressions must be interpreted as a set of filters that are ANDed together. + * Implementations may use the filters to prune originally planned {@link InputPartition}s. + * <p> + * Spark will call {@link Scan#toBatch()}, {@link Scan#toMicroBatchStream(String)} or + * {@link Scan#toContinuousStream(String)} again after filtering the scan dynamically. + * The newly produced {@link Batch} or its streaming alternative may report a subset of + * originally planned {@link InputPartition}s. + * + * @param filters dynamic filters + */ + void filter(Filter[] filters); Review comment: I think that this should use v1 filters. The new filters don't exist yet and the DSv2 API uses v1 in other places. There is no need to block this on adding v2 filters. If the release for this is the same for v2 filters, we can consider removing support. But at this point I think we should not assume that will happen. -- 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. For queries about this service, please contact Infrastructure at: us...@infra.apache.org --------------------------------------------------------------------- To unsubscribe, e-mail: reviews-unsubscr...@spark.apache.org For additional commands, e-mail: reviews-h...@spark.apache.org
