parthchandra commented on code in PR #45505: URL: https://github.com/apache/spark/pull/45505#discussion_r1525407443
########## sql/catalyst/src/main/java/org/apache/spark/sql/connector/metric/CustomFileTaskMetric.java: ########## @@ -0,0 +1,63 @@ +/* + * 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.metric; + +import java.util.ArrayList; +import java.util.List; +import java.util.Optional; +import org.apache.spark.annotation.Evolving; Review Comment: Done ########## sql/catalyst/src/main/java/org/apache/spark/sql/connector/metric/CustomFileTaskMetric.java: ########## @@ -0,0 +1,63 @@ +/* + * 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.metric; + +import java.util.ArrayList; +import java.util.List; +import java.util.Optional; +import org.apache.spark.annotation.Evolving; + +/** + * A custom file task metric. This allows file based data source V2 implementations + * to use a single PartitionReader with multiple file readers. Each file reader can + * provide its own metrics values and they can be added into the parent PartitionReader + * @since 4.0.0 Review Comment: Done ########## sql/catalyst/src/main/java/org/apache/spark/sql/connector/metric/CustomFileTaskMetric.java: ########## @@ -0,0 +1,63 @@ +/* + * 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.metric; + +import java.util.ArrayList; +import java.util.List; +import java.util.Optional; +import org.apache.spark.annotation.Evolving; + +/** + * A custom file task metric. This allows file based data source V2 implementations + * to use a single PartitionReader with multiple file readers. Each file reader can + * provide its own metrics values and they can be added into the parent PartitionReader + * @since 4.0.0 + */ +@Evolving +public interface CustomFileTaskMetric extends CustomTaskMetric { + + /** + * Updates the underlying value of the metric by adding addValue to the existing value + */ + default void update(long addValue) {} + + + /* + Merge(add) the values of the corresponding CustomTaskMetric from src array into target array + adding a new element if it doesn't already exist. Returns a new array without modifying the + target array Review Comment: Reformatted ########## sql/catalyst/src/main/java/org/apache/spark/sql/connector/metric/CustomFileTaskMetric.java: ########## @@ -0,0 +1,63 @@ +/* + * 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.metric; + +import java.util.ArrayList; +import java.util.List; +import java.util.Optional; +import org.apache.spark.annotation.Evolving; + +/** + * A custom file task metric. This allows file based data source V2 implementations + * to use a single PartitionReader with multiple file readers. Each file reader can + * provide its own metrics values and they can be added into the parent PartitionReader + * @since 4.0.0 + */ +@Evolving +public interface CustomFileTaskMetric extends CustomTaskMetric { + + /** + * Updates the underlying value of the metric by adding addValue to the existing value + */ + default void update(long addValue) {} + + + /* + Merge(add) the values of the corresponding CustomTaskMetric from src array into target array + adding a new element if it doesn't already exist. Returns a new array without modifying the + target array + */ + static List<CustomFileTaskMetric> mergeMetricValues(List<CustomTaskMetric> src, Review Comment: That's right. This is a utility method and there really isn't any other good place to put this. Anyway, I've moved it to `org.apache.spark.sql.execution.metric.CustomMetrics`. One difference is that the function was in a Java class earlier and is now in a Scala class. In general, that makes it slightly harder for a DSV2 implementation to use it because calling Scala from Java is still not perfect. -- 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]
