This is an automated email from the ASF dual-hosted git repository.
gurwls223 pushed a commit to branch branch-3.1
in repository https://gitbox.apache.org/repos/asf/spark.git
The following commit(s) were added to refs/heads/branch-3.1 by this push:
new 5dd54f9 [MINOR][DOC] Fix documentation for structured streaming -
addListener
5dd54f9 is described below
commit 5dd54f9e341faee3653518e072c77077455cc84f
Author: Karthik Subramanian <kars...@microsoft.com>
AuthorDate: Fri Feb 18 12:52:11 2022 +0900
[MINOR][DOC] Fix documentation for structured streaming - addListener
### What changes were proposed in this pull request?
This PR fixes the incorrect documentation in Structured Streaming Guide
where it says `sparkSession.streams.attachListener()` instead of
`sparkSession.streams.addListener()` which is the correct usage as mentioned in
the code snippet below in the same doc.
### Why are the changes needed?
The documentation was erroneous, and needs to be fixed to avoid confusion
by readers
### Does this PR introduce _any_ user-facing change?
Yes, since it's a doc fix. This fix needs to be applied to previous
versions retro-actively as well.
### How was this patch tested?
Not necessary
Closes #35562 from yeskarthik/fix-structured-streaming-docs-1.
Authored-by: Karthik Subramanian <kars...@microsoft.com>
Signed-off-by: Hyukjin Kwon <gurwls...@apache.org>
(cherry picked from commit 837248a0c42d55ad48240647d503ad544e64f016)
Signed-off-by: Hyukjin Kwon <gurwls...@apache.org>
---
docs/structured-streaming-programming-guide.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/docs/structured-streaming-programming-guide.md
b/docs/structured-streaming-programming-guide.md
index 432ec7d..c0b65ac 100644
--- a/docs/structured-streaming-programming-guide.md
+++ b/docs/structured-streaming-programming-guide.md
@@ -3020,7 +3020,7 @@ You can also asynchronously monitor all queries
associated with a
`SparkSession` by attaching a `StreamingQueryListener`
([Scala](api/scala/org/apache/spark/sql/streaming/StreamingQueryListener.html)/[Java](api/java/org/apache/spark/sql/streaming/StreamingQueryListener.html)
docs).
Once you attach your custom `StreamingQueryListener` object with
-`sparkSession.streams.attachListener()`, you will get callbacks when a query
is started and
+`sparkSession.streams.addListener()`, you will get callbacks when a query is
started and
stopped and when there is progress made in an active query. Here is an example,
<div class="codetabs">
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscr...@spark.apache.org
For additional commands, e-mail: commits-h...@spark.apache.org
