Github user zsxwing commented on a diff in the pull request: https://github.com/apache/spark/pull/11030#discussion_r52371427 --- Diff: sql/core/src/main/scala/org/apache/spark/sql/util/ContinuousQueryListener.scala --- @@ -0,0 +1,67 @@ +/* + * 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.util + +import org.apache.spark.annotation.Experimental +import org.apache.spark.sql.ContinuousQuery +import org.apache.spark.sql.util.ContinuousQueryListener._ + +/** + * :: Experimental :: + * Interface for listening to events related to [[ContinuousQuery ContinuousQueries]]. + * @note The methods are not thread-safe as they may be called from different threads. + */ +@Experimental +abstract class ContinuousQueryListener { + + /** + * Called when a query is started. + * @note This is called synchronously with + * [[org.apache.spark.sql.DataFrameWriter `DataFrameWriter.stream()`]], + * that is, `onQueryStart` will be called on all listeners before `DataFrameWriter.stream()` + * returns the corresponding [[ContinuousQuery]]. + */ + def onQueryStarted(queryStarted: QueryStarted) + + /** Called when there is some status update (ingestion rate updated, etc. */ + def onQueryProgress(queryProgress: QueryProgress) + + /** Called when a query is stopped, with or without error */ + def onQueryTerminated(queryTerminated: QueryTerminated) +} + + +/** + * :: Experimental :: + * Companion object of [[ContinuousQueryListener]] that defines the listener events. + */ +@Experimental +object ContinuousQueryListener { + + /** Base type of [[ContinuousQueryListener]] events */ --- End diff -- nit: extra space
--- If your project is set up for it, you can reply to this email and have your reply appear on GitHub as well. If your project does not have this feature enabled and wishes so, or if the feature is enabled but not working, please contact infrastructure at infrastruct...@apache.org or file a JIRA ticket with INFRA. --- --------------------------------------------------------------------- To unsubscribe, e-mail: reviews-unsubscr...@spark.apache.org For additional commands, e-mail: reviews-h...@spark.apache.org