blob: f9f0fa3d4097d958028ee76c5ecb6f1f531b3ca3 [file] [log] [blame]
<!DOCTYPE html><html><head><title>R: awaitTermination</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes" />
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/katex@0.15.3/dist/katex.min.css">
<script type="text/javascript">
const macros = { "\\R": "\\textsf{R}", "\\code": "\\texttt"};
function processMathHTML() {
var l = document.getElementsByClassName('reqn');
for (let e of l) { katex.render(e.textContent, e, { throwOnError: false, macros }); }
return;
}</script>
<script defer src="https://cdn.jsdelivr.net/npm/katex@0.15.3/dist/katex.min.js"
onload="processMathHTML();"></script>
<link rel="stylesheet" type="text/css" href="R.css" />
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/8.3/styles/github.min.css">
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/8.3/highlight.min.js"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/8.3/languages/r.min.js"></script>
<script>hljs.initHighlightingOnLoad();</script>
</head><body><div class="container">
<table style="width: 100%;"><tr><td>awaitTermination {SparkR}</td><td style="text-align: right;">R Documentation</td></tr></table>
<h2>awaitTermination</h2>
<h3>Description</h3>
<p>Waits for the termination of the query, either by <code>stopQuery</code> or by an error.
</p>
<h3>Usage</h3>
<pre><code class='language-R'>awaitTermination(x, timeout = NULL)
## S4 method for signature 'StreamingQuery'
awaitTermination(x, timeout = NULL)
</code></pre>
<h3>Arguments</h3>
<table>
<tr style="vertical-align: top;"><td><code>x</code></td>
<td>
<p>a StreamingQuery.</p>
</td></tr>
<tr style="vertical-align: top;"><td><code>timeout</code></td>
<td>
<p>time to wait in milliseconds, if omitted, wait indefinitely until <code>stopQuery</code>
is called or an error has occurred.</p>
</td></tr>
</table>
<h3>Details</h3>
<p>If the query has terminated, then all subsequent calls to this method will return TRUE
immediately.
</p>
<h3>Value</h3>
<p>TRUE if query has terminated within the timeout period; nothing if timeout is not
specified.
</p>
<h3>Note</h3>
<p>awaitTermination(StreamingQuery) since 2.2.0
</p>
<p>experimental
</p>
<h3>See Also</h3>
<p>Other StreamingQuery methods:
<code><a href="../../SparkR/help/explain.html">explain</a>()</code>,
<code><a href="../../SparkR/help/isActive.html">isActive</a>()</code>,
<code><a href="../../SparkR/help/lastProgress.html">lastProgress</a>()</code>,
<code><a href="../../SparkR/help/queryName.html">queryName</a>()</code>,
<code><a href="../../SparkR/help/status.html">status</a>()</code>,
<code><a href="../../SparkR/help/stopQuery.html">stopQuery</a>()</code>
</p>
<h3>Examples</h3>
<pre><code class="r">## Not run: awaitTermination(sq, 10000)
</code></pre>
<hr /><div style="text-align: center;">[Package <em>SparkR</em> version 3.2.2 <a href="00Index.html">Index</a>]</div>
</div>
</body></html>