This is an automated email from the ASF dual-hosted git repository.
github-bot pushed a commit to branch asf-site
in repository https://gitbox.apache.org/repos/asf/datafusion-comet.git
The following commit(s) were added to refs/heads/asf-site by this push:
new 183ccbc2 Publish built docs triggered by
46a28db5e5014fc7fabe8eafc7dbeb5027974c47
183ccbc2 is described below
commit 183ccbc2a30526b896b5349bd53d326c2523abe0
Author: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
AuthorDate: Tue Dec 17 23:51:04 2024 +0000
Publish built docs triggered by 46a28db5e5014fc7fabe8eafc7dbeb5027974c47
---
_sources/user-guide/tuning.md.txt | 10 ++++++++++
searchindex.js | 2 +-
user-guide/tuning.html | 25 +++++++++++++++++++++++++
3 files changed, 36 insertions(+), 1 deletion(-)
diff --git a/_sources/user-guide/tuning.md.txt
b/_sources/user-guide/tuning.md.txt
index af722494..f10a0dde 100644
--- a/_sources/user-guide/tuning.md.txt
+++ b/_sources/user-guide/tuning.md.txt
@@ -127,3 +127,13 @@ Here is a guide to some of the native metrics.
| `elapsed_compute` | Total time spent in this operator, fetching batches from
a JVM iterator. |
| `jvm_fetch_time` | Time spent in the JVM fetching input batches to be read
by this `ScanExec` instance. |
| `arrow_ffi_time` | Time spent using Arrow FFI to create Arrow batches from
the memory addresses returned from the JVM. |
+
+## Explain Plan
+### Extended Explain
+With Spark 4.0.0 and newer, Comet can provide extended explain plan
information in the Spark UI. Currently this lists
+reasons why Comet may not have been enabled for specific operations.
+To enable this, in the Spark configuration, set the following:
+```shell
+-c spark.sql.extendedExplainProviders=org.apache.comet.ExtendedExplainInfo
+```
+This will add a section to the detailed plan displayed in the Spark SQL UI
page.
\ No newline at end of file
diff --git a/searchindex.js b/searchindex.js
index 74291463..d7f82382 100644
--- a/searchindex.js
+++ b/searchindex.js
@@ -1 +1 @@
-Search.setIndex({"alltitles": {"1. Install Comet": [[9, "install-comet"]], "2.
Clone Spark and Apply Diff": [[9, "clone-spark-and-apply-diff"]], "3. Run Spark
SQL Tests": [[9, "run-spark-sql-tests"]], "ANSI mode": [[11, "ansi-mode"]],
"API Differences Between Spark Versions": [[0,
"api-differences-between-spark-versions"]], "ASF Links": [[10, null]], "Adding
Spark-side Tests for the New Expression": [[0,
"adding-spark-side-tests-for-the-new-expression"]], "Adding a New Expression":
[[0, [...]
\ No newline at end of file
+Search.setIndex({"alltitles": {"1. Install Comet": [[9, "install-comet"]], "2.
Clone Spark and Apply Diff": [[9, "clone-spark-and-apply-diff"]], "3. Run Spark
SQL Tests": [[9, "run-spark-sql-tests"]], "ANSI mode": [[11, "ansi-mode"]],
"API Differences Between Spark Versions": [[0,
"api-differences-between-spark-versions"]], "ASF Links": [[10, null]], "Adding
Spark-side Tests for the New Expression": [[0,
"adding-spark-side-tests-for-the-new-expression"]], "Adding a New Expression":
[[0, [...]
\ No newline at end of file
diff --git a/user-guide/tuning.html b/user-guide/tuning.html
index 7032944d..f6c1019b 100644
--- a/user-guide/tuning.html
+++ b/user-guide/tuning.html
@@ -354,6 +354,18 @@ under the License.
</li>
</ul>
</li>
+ <li class="toc-h2 nav-item toc-entry">
+ <a class="reference internal nav-link" href="#explain-plan">
+ Explain Plan
+ </a>
+ <ul class="nav section-nav flex-column">
+ <li class="toc-h3 nav-item toc-entry">
+ <a class="reference internal nav-link" href="#extended-explain">
+ Extended Explain
+ </a>
+ </li>
+ </ul>
+ </li>
</ul>
</nav>
@@ -512,6 +524,19 @@ logged for each native plan (and there is one plan per
task, so this is very ver
</table>
</section>
</section>
+<section id="explain-plan">
+<h2>Explain Plan<a class="headerlink" href="#explain-plan" title="Link to this
heading">¶</a></h2>
+<section id="extended-explain">
+<h3>Extended Explain<a class="headerlink" href="#extended-explain" title="Link
to this heading">¶</a></h3>
+<p>With Spark 4.0.0 and newer, Comet can provide extended explain plan
information in the Spark UI. Currently this lists
+reasons why Comet may not have been enabled for specific operations.
+To enable this, in the Spark configuration, set the following:</p>
+<div class="highlight-shell notranslate"><div
class="highlight"><pre><span></span>-c<span class="w">
</span>spark.sql.extendedExplainProviders<span
class="o">=</span>org.apache.comet.ExtendedExplainInfo
+</pre></div>
+</div>
+<p>This will add a section to the detailed plan displayed in the Spark SQL UI
page.</p>
+</section>
+</section>
</section>
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
