anishshri-db commented on code in PR #43961: URL: https://github.com/apache/spark/pull/43961#discussion_r1432036860
########## sql/api/src/main/scala/org/apache/spark/sql/streaming/StatefulProcessorHandle.scala: ########## @@ -0,0 +1,43 @@ +/* + * 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.streaming + +import java.io.Serializable + +import org.apache.spark.annotation.{Evolving, Experimental} + +/** + * Represents the operation handle provided to the stateful processor used in the + * arbitrary state API v2. + */ +@Experimental +@Evolving +trait StatefulProcessorHandle extends Serializable { + + /** + * Function to create new or return existing single value state variable of given type + * The user must ensure to call this function only within the `init()` method of the + * StatefulProcessor. + * @param stateName - name of the state variable + * @tparam T - type of state variable + * @return - instance of ValueState of type T that can be used to store state persistently + */ + def getValueState[T](stateName: String): ValueState[T] + + /** Function to return queryInfo for currently running task */ + def getQueryInfo(): QueryInfo Review Comment: Oh this is meant for 2 primary reasons: - to easily identify retry attempts (user could query batch id to ensure calls to external services could be made idempotent) - to aid in debugging (i.e. to understand and isolate any issues for specific query/run/batch/partition) -- 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]
