This is an automated email from the ASF dual-hosted git repository.

gurwls223 pushed a commit to branch branch-2.4
in repository https://gitbox.apache.org/repos/asf/spark.git


The following commit(s) were added to refs/heads/branch-2.4 by this push:
     new b15866c  [MINOR][DOCS] Fix invalid documentation for 
StreamingQueryManager Class
b15866c is described below

commit b15866cec48a3f61927283ba2afdc5616b702de9
Author: Asaf Levy <asaf...@gmail.com>
AuthorDate: Wed May 8 23:45:05 2019 +0900

    [MINOR][DOCS] Fix invalid documentation for StreamingQueryManager Class
    
    ## What changes were proposed in this pull request?
    
    When following the example for using `spark.streams().awaitAnyTermination()`
    a valid pyspark code will output the following error:
    
    ```
    Traceback (most recent call last):
      File "pyspark_app.py", line 182, in <module>
        spark.streams().awaitAnyTermination()
    TypeError: 'StreamingQueryManager' object is not callable
    ```
    
    Docs URL: 
https://spark.apache.org/docs/latest/structured-streaming-programming-guide.html#managing-streaming-queries
    
    This changes the documentation line to properly call the method under the 
StreamingQueryManager Class
    
https://spark.apache.org/docs/latest/api/python/pyspark.sql.html#pyspark.sql.streaming.StreamingQueryManager
    
    ## How was this patch tested?
    
    After changing the syntax, error no longer occurs and pyspark application 
works
    
    This is only docs change
    
    Closes #24547 from asaf400/patch-1.
    
    Authored-by: Asaf Levy <asaf...@gmail.com>
    Signed-off-by: HyukjinKwon <gurwls...@apache.org>
    (cherry picked from commit 09422f5139cc13abaf506453819c2bb91e174ae3)
    Signed-off-by: HyukjinKwon <gurwls...@apache.org>
---
 docs/structured-streaming-programming-guide.md | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/docs/structured-streaming-programming-guide.md 
b/docs/structured-streaming-programming-guide.md
index 3d91223..f0971ab 100644
--- a/docs/structured-streaming-programming-guide.md
+++ b/docs/structured-streaming-programming-guide.md
@@ -2539,11 +2539,11 @@ spark.streams().awaitAnyTermination();   // block until 
any one of them terminat
 {% highlight python %}
 spark = ...  # spark session
 
-spark.streams().active  # get the list of currently active streaming queries
+spark.streams.active  # get the list of currently active streaming queries
 
-spark.streams().get(id)  # get a query object by its unique id
+spark.streams.get(id)  # get a query object by its unique id
 
-spark.streams().awaitAnyTermination()  # block until any one of them terminates
+spark.streams.awaitAnyTermination()  # block until any one of them terminates
 {% endhighlight %}
 
 </div>


---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscr...@spark.apache.org
For additional commands, e-mail: commits-h...@spark.apache.org

Reply via email to