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 e6d470a5 Publish built docs triggered by
1d1479ece50957060684d663d3d79c2317f916be
e6d470a5 is described below
commit e6d470a5a9adc901eef6c199be32db5db5787667
Author: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
AuthorDate: Fri Aug 9 08:42:54 2024 +0000
Publish built docs triggered by 1d1479ece50957060684d663d3d79c2317f916be
---
_sources/user-guide/configs.md.txt | 1 +
contributor-guide/adding_a_new_expression.html | 2 +-
contributor-guide/benchmarking.html | 2 +-
contributor-guide/contributing.html | 2 +-
contributor-guide/debugging.html | 2 +-
contributor-guide/development.html | 2 +-
contributor-guide/plugin_overview.html | 2 +-
contributor-guide/profiling_native_code.html | 2 +-
contributor-guide/spark-sql-tests.html | 2 +-
genindex.html | 2 +-
index.html | 2 +-
search.html | 2 +-
searchindex.js | 2 +-
user-guide/compatibility.html | 2 +-
user-guide/configs.html | 30 +++++++++++++++-----------
user-guide/datatypes.html | 2 +-
user-guide/expressions.html | 2 +-
user-guide/installation.html | 2 +-
user-guide/operators.html | 2 +-
user-guide/overview.html | 2 +-
user-guide/tuning.html | 2 +-
21 files changed, 37 insertions(+), 32 deletions(-)
diff --git a/_sources/user-guide/configs.md.txt
b/_sources/user-guide/configs.md.txt
index 74a2104b..f95c29ae 100644
--- a/_sources/user-guide/configs.md.txt
+++ b/_sources/user-guide/configs.md.txt
@@ -39,6 +39,7 @@ Comet provides the following configuration settings.
| spark.comet.exec.shuffle.codec | The codec of Comet native shuffle used to
compress shuffle data. Only zstd is supported. | zstd |
| spark.comet.exec.shuffle.enabled | Whether to enable Comet native shuffle.
By default, this config is false. Note that this requires setting
'spark.shuffle.manager' to
'org.apache.spark.sql.comet.execution.shuffle.CometShuffleManager'.
'spark.shuffle.manager' must be set before starting the Spark application and
cannot be changed during the application. | false |
| spark.comet.exec.shuffle.mode | The mode of Comet shuffle. This config is
only effective if Comet shuffle is enabled. Available modes are 'native',
'jvm', and 'auto'. 'native' is for native shuffle which has best performance in
general. 'jvm' is for jvm-based columnar shuffle which has higher coverage than
native shuffle. 'auto' is for Comet to choose the best shuffle mode based on
the query plan. By default, this config is 'jvm'. | jvm |
+| spark.comet.explain.native.enabled | When this setting is enabled, Comet
will provide a tree representation of the native query plan before execution
and again after execution, with metrics. | false |
| spark.comet.explain.verbose.enabled | When this setting is enabled, Comet
will provide a verbose tree representation of the extended information. | false
|
| spark.comet.explainFallback.enabled | When this setting is enabled, Comet
will provide logging explaining the reason(s) why a query stage cannot be
executed natively. Set this to false to reduce the amount of logging. | false |
| spark.comet.memory.overhead.factor | Fraction of executor memory to be
allocated as additional non-heap memory per executor process for Comet. Default
value is 0.2. | 0.2 |
diff --git a/contributor-guide/adding_a_new_expression.html
b/contributor-guide/adding_a_new_expression.html
index 76409ab7..deb333de 100644
--- a/contributor-guide/adding_a_new_expression.html
+++ b/contributor-guide/adding_a_new_expression.html
@@ -599,7 +599,7 @@ under the License.
<div class="footer-item">
<p class="sphinx-version">
-Created using <a href="http://sphinx-doc.org/";>Sphinx</a> 7.4.7.<br>
+Created using <a href="http://sphinx-doc.org/";>Sphinx</a> 8.0.2.<br>
</p>
</div>
diff --git a/contributor-guide/benchmarking.html
b/contributor-guide/benchmarking.html
index be32af2e..beebe707 100644
--- a/contributor-guide/benchmarking.html
+++ b/contributor-guide/benchmarking.html
@@ -456,7 +456,7 @@ you to run these benchmarks in your own environments.</p>
<div class="footer-item">
<p class="sphinx-version">
-Created using <a href="http://sphinx-doc.org/";>Sphinx</a> 7.4.7.<br>
+Created using <a href="http://sphinx-doc.org/";>Sphinx</a> 8.0.2.<br>
</p>
</div>
diff --git a/contributor-guide/contributing.html
b/contributor-guide/contributing.html
index b06300d1..5692c15e 100644
--- a/contributor-guide/contributing.html
+++ b/contributor-guide/contributing.html
@@ -405,7 +405,7 @@ coordinate on issues that they are working on.</p>
<div class="footer-item">
<p class="sphinx-version">
-Created using <a href="http://sphinx-doc.org/";>Sphinx</a> 7.4.7.<br>
+Created using <a href="http://sphinx-doc.org/";>Sphinx</a> 8.0.2.<br>
</p>
</div>
diff --git a/contributor-guide/debugging.html b/contributor-guide/debugging.html
index ab4e6ecf..ceef3e1d 100644
--- a/contributor-guide/debugging.html
+++ b/contributor-guide/debugging.html
@@ -516,7 +516,7 @@ To enable this option with Comet it is needed to include
<code class="docutils l
<div class="footer-item">
<p class="sphinx-version">
-Created using <a href="http://sphinx-doc.org/";>Sphinx</a> 7.4.7.<br>
+Created using <a href="http://sphinx-doc.org/";>Sphinx</a> 8.0.2.<br>
</p>
</div>
diff --git a/contributor-guide/development.html
b/contributor-guide/development.html
index 45c042bb..ce662257 100644
--- a/contributor-guide/development.html
+++ b/contributor-guide/development.html
@@ -531,7 +531,7 @@ automatically format the code. Before submitting a pull
request, you can simply
<div class="footer-item">
<p class="sphinx-version">
-Created using <a href="http://sphinx-doc.org/";>Sphinx</a> 7.4.7.<br>
+Created using <a href="http://sphinx-doc.org/";>Sphinx</a> 8.0.2.<br>
</p>
</div>
diff --git a/contributor-guide/plugin_overview.html
b/contributor-guide/plugin_overview.html
index 316359eb..e1ca5cae 100644
--- a/contributor-guide/plugin_overview.html
+++ b/contributor-guide/plugin_overview.html
@@ -397,7 +397,7 @@ override the DataFusion versions to ensure compatibility
with Apache Spark.</p>
<div class="footer-item">
<p class="sphinx-version">
-Created using <a href="http://sphinx-doc.org/";>Sphinx</a> 7.4.7.<br>
+Created using <a href="http://sphinx-doc.org/";>Sphinx</a> 8.0.2.<br>
</p>
</div>
diff --git a/contributor-guide/profiling_native_code.html
b/contributor-guide/profiling_native_code.html
index 13237050..26525809 100644
--- a/contributor-guide/profiling_native_code.html
+++ b/contributor-guide/profiling_native_code.html
@@ -425,7 +425,7 @@ running flamegraph.</p>
<div class="footer-item">
<p class="sphinx-version">
-Created using <a href="http://sphinx-doc.org/";>Sphinx</a> 7.4.7.<br>
+Created using <a href="http://sphinx-doc.org/";>Sphinx</a> 8.0.2.<br>
</p>
</div>
diff --git a/contributor-guide/spark-sql-tests.html
b/contributor-guide/spark-sql-tests.html
index dbf30146..c99921fb 100644
--- a/contributor-guide/spark-sql-tests.html
+++ b/contributor-guide/spark-sql-tests.html
@@ -475,7 +475,7 @@ new version.</p>
<div class="footer-item">
<p class="sphinx-version">
-Created using <a href="http://sphinx-doc.org/";>Sphinx</a> 7.4.7.<br>
+Created using <a href="http://sphinx-doc.org/";>Sphinx</a> 8.0.2.<br>
</p>
</div>
diff --git a/genindex.html b/genindex.html
index 7add7755..d3a3e3e8 100644
--- a/genindex.html
+++ b/genindex.html
@@ -300,7 +300,7 @@ under the License.
<div class="footer-item">
<p class="sphinx-version">
-Created using <a href="http://sphinx-doc.org/";>Sphinx</a> 7.4.7.<br>
+Created using <a href="http://sphinx-doc.org/";>Sphinx</a> 8.0.2.<br>
</p>
</div>
diff --git a/index.html b/index.html
index 4dd36911..f976f26f 100644
--- a/index.html
+++ b/index.html
@@ -373,7 +373,7 @@ as a native runtime to achieve improvement in terms of
query efficiency and quer
<div class="footer-item">
<p class="sphinx-version">
-Created using <a href="http://sphinx-doc.org/";>Sphinx</a> 7.4.7.<br>
+Created using <a href="http://sphinx-doc.org/";>Sphinx</a> 8.0.2.<br>
</p>
</div>
diff --git a/search.html b/search.html
index 76d42cf8..0224a2de 100644
--- a/search.html
+++ b/search.html
@@ -327,7 +327,7 @@ under the License.
<div class="footer-item">
<p class="sphinx-version">
-Created using <a href="http://sphinx-doc.org/";>Sphinx</a> 7.4.7.<br>
+Created using <a href="http://sphinx-doc.org/";>Sphinx</a> 8.0.2.<br>
</p>
</div>
diff --git a/searchindex.js b/searchindex.js
index 5e3e464c..550432f7 100644
--- a/searchindex.js
+++ b/searchindex.js
@@ -1 +1 @@
-Search.setIndex({"alltitles": {"1. Install Comet": [[7, "install-comet"]], "2.
Clone Spark and Apply Diff": [[7, "clone-spark-and-apply-diff"]], "3. Run Spark
SQL Tests": [[7, "run-spark-sql-tests"]], "ANSI mode": [[9, "ansi-mode"]], "API
Differences Between Spark Versions": [[0,
"api-differences-between-spark-versions"]], "ASF Links": [[8, null]], "Adding
Spark-side Tests for the New Expression": [[0,
"adding-spark-side-tests-for-the-new-expression"]], "Adding a New Expression":
[[0, nu [...]
\ No newline at end of file
+Search.setIndex({"alltitles": {"1. Install Comet": [[7, "install-comet"]], "2.
Clone Spark and Apply Diff": [[7, "clone-spark-and-apply-diff"]], "3. Run Spark
SQL Tests": [[7, "run-spark-sql-tests"]], "ANSI mode": [[9, "ansi-mode"]], "API
Differences Between Spark Versions": [[0,
"api-differences-between-spark-versions"]], "ASF Links": [[8, null]], "Adding
Spark-side Tests for the New Expression": [[0,
"adding-spark-side-tests-for-the-new-expression"]], "Adding a New Expression":
[[0, nu [...]
\ No newline at end of file
diff --git a/user-guide/compatibility.html b/user-guide/compatibility.html
index 1ef35481..e0eb498e 100644
--- a/user-guide/compatibility.html
+++ b/user-guide/compatibility.html
@@ -752,7 +752,7 @@ Spark.</p></li>
<div class="footer-item">
<p class="sphinx-version">
-Created using <a href="http://sphinx-doc.org/";>Sphinx</a> 7.4.7.<br>
+Created using <a href="http://sphinx-doc.org/";>Sphinx</a> 8.0.2.<br>
</p>
</div>
diff --git a/user-guide/configs.html b/user-guide/configs.html
index f1c017cf..ee360e54 100644
--- a/user-guide/configs.html
+++ b/user-guide/configs.html
@@ -382,51 +382,55 @@ under the License.
<td><p>The mode of Comet shuffle. This config is only effective if Comet
shuffle is enabled. Available modes are ‘native’, ‘jvm’, and ‘auto’. ‘native’
is for native shuffle which has best performance in general. ‘jvm’ is for
jvm-based columnar shuffle which has higher coverage than native shuffle.
‘auto’ is for Comet to choose the best shuffle mode based on the query plan. By
default, this config is ‘jvm’.</p></td>
<td><p>jvm</p></td>
</tr>
-<tr class="row-even"><td><p>spark.comet.explain.verbose.enabled</p></td>
+<tr class="row-even"><td><p>spark.comet.explain.native.enabled</p></td>
+<td><p>When this setting is enabled, Comet will provide a tree representation
of the native query plan before execution and again after execution, with
metrics.</p></td>
+<td><p>false</p></td>
+</tr>
+<tr class="row-odd"><td><p>spark.comet.explain.verbose.enabled</p></td>
<td><p>When this setting is enabled, Comet will provide a verbose tree
representation of the extended information.</p></td>
<td><p>false</p></td>
</tr>
-<tr class="row-odd"><td><p>spark.comet.explainFallback.enabled</p></td>
+<tr class="row-even"><td><p>spark.comet.explainFallback.enabled</p></td>
<td><p>When this setting is enabled, Comet will provide logging explaining the
reason(s) why a query stage cannot be executed natively. Set this to false to
reduce the amount of logging.</p></td>
<td><p>false</p></td>
</tr>
-<tr class="row-even"><td><p>spark.comet.memory.overhead.factor</p></td>
+<tr class="row-odd"><td><p>spark.comet.memory.overhead.factor</p></td>
<td><p>Fraction of executor memory to be allocated as additional non-heap
memory per executor process for Comet. Default value is 0.2.</p></td>
<td><p>0.2</p></td>
</tr>
-<tr class="row-odd"><td><p>spark.comet.memory.overhead.min</p></td>
+<tr class="row-even"><td><p>spark.comet.memory.overhead.min</p></td>
<td><p>Minimum amount of additional memory to be allocated per executor
process for Comet, in MiB.</p></td>
<td><p>402653184b</p></td>
</tr>
-<tr class="row-even"><td><p>spark.comet.nativeLoadRequired</p></td>
+<tr class="row-odd"><td><p>spark.comet.nativeLoadRequired</p></td>
<td><p>Whether to require Comet native library to load successfully when Comet
is enabled. If not, Comet will silently fallback to Spark when it fails to load
the native lib. Otherwise, an error will be thrown and the Spark job will be
aborted.</p></td>
<td><p>false</p></td>
</tr>
-<tr class="row-odd"><td><p>spark.comet.parquet.enable.directBuffer</p></td>
+<tr class="row-even"><td><p>spark.comet.parquet.enable.directBuffer</p></td>
<td><p>Whether to use Java direct byte buffer when reading Parquet. By
default, this is false</p></td>
<td><p>false</p></td>
</tr>
-<tr class="row-even"><td><p>spark.comet.regexp.allowIncompatible</p></td>
+<tr class="row-odd"><td><p>spark.comet.regexp.allowIncompatible</p></td>
<td><p>Comet is not currently fully compatible with Spark for all regular
expressions. Set this config to true to allow them anyway using Rust’s regular
expression engine. See compatibility guide for more information.</p></td>
<td><p>false</p></td>
</tr>
-<tr
class="row-odd"><td><p>spark.comet.rowToColumnar.supportedOperatorList</p></td>
+<tr
class="row-even"><td><p>spark.comet.rowToColumnar.supportedOperatorList</p></td>
<td><p>A comma-separated list of row-based operators that will be converted to
columnar format when ‘spark.comet.rowToColumnar.enabled’ is true</p></td>
<td><p>Range,InMemoryTableScan</p></td>
</tr>
-<tr class="row-even"><td><p>spark.comet.scan.enabled</p></td>
+<tr class="row-odd"><td><p>spark.comet.scan.enabled</p></td>
<td><p>Whether to enable Comet scan. When this is turned on, Spark will use
Comet to read Parquet data source. Note that to enable native vectorized
execution, both this config and ‘spark.comet.exec.enabled’ need to be enabled.
By default, this config is true.</p></td>
<td><p>true</p></td>
</tr>
-<tr class="row-odd"><td><p>spark.comet.scan.preFetch.enabled</p></td>
+<tr class="row-even"><td><p>spark.comet.scan.preFetch.enabled</p></td>
<td><p>Whether to enable pre-fetching feature of CometScan. By default is
disabled.</p></td>
<td><p>false</p></td>
</tr>
-<tr class="row-even"><td><p>spark.comet.scan.preFetch.threadNum</p></td>
+<tr class="row-odd"><td><p>spark.comet.scan.preFetch.threadNum</p></td>
<td><p>The number of threads running pre-fetching for CometScan. Effective if
spark.comet.scan.preFetch.enabled is enabled. By default it is 2. Note that
more pre-fetching threads means more memory requirement to store pre-fetched
row groups.</p></td>
<td><p>2</p></td>
</tr>
-<tr class="row-odd"><td><p>spark.comet.shuffle.preferDictionary.ratio</p></td>
+<tr class="row-even"><td><p>spark.comet.shuffle.preferDictionary.ratio</p></td>
<td><p>The ratio of total values to distinct values in a string column to
decide whether to prefer dictionary encoding when shuffling the column. If the
ratio is higher than this config, dictionary encoding will be used on shuffling
string column. This config is effective if it is higher than 1.0. By default,
this config is 10.0. Note that this config is only used when <code
class="docutils literal notranslate"><span
class="pre">spark.comet.exec.shuffle.mode</span></code> is <code class= [...]
<td><p>10.0</p></td>
</tr>
@@ -476,7 +480,7 @@ under the License.
<div class="footer-item">
<p class="sphinx-version">
-Created using <a href="http://sphinx-doc.org/";>Sphinx</a> 7.4.7.<br>
+Created using <a href="http://sphinx-doc.org/";>Sphinx</a> 8.0.2.<br>
</p>
</div>
diff --git a/user-guide/datatypes.html b/user-guide/datatypes.html
index f0291c64..e4ff9828 100644
--- a/user-guide/datatypes.html
+++ b/user-guide/datatypes.html
@@ -379,7 +379,7 @@ under the License.
<div class="footer-item">
<p class="sphinx-version">
-Created using <a href="http://sphinx-doc.org/";>Sphinx</a> 7.4.7.<br>
+Created using <a href="http://sphinx-doc.org/";>Sphinx</a> 8.0.2.<br>
</p>
</div>
diff --git a/user-guide/expressions.html b/user-guide/expressions.html
index bf476333..b2f4e7c8 100644
--- a/user-guide/expressions.html
+++ b/user-guide/expressions.html
@@ -901,7 +901,7 @@ under the License.
<div class="footer-item">
<p class="sphinx-version">
-Created using <a href="http://sphinx-doc.org/";>Sphinx</a> 7.4.7.<br>
+Created using <a href="http://sphinx-doc.org/";>Sphinx</a> 8.0.2.<br>
</p>
</div>
diff --git a/user-guide/installation.html b/user-guide/installation.html
index 775a68b5..1c6f4530 100644
--- a/user-guide/installation.html
+++ b/user-guide/installation.html
@@ -517,7 +517,7 @@ components which will then fail at runtime. For example:</p>
<div class="footer-item">
<p class="sphinx-version">
-Created using <a href="http://sphinx-doc.org/";>Sphinx</a> 7.4.7.<br>
+Created using <a href="http://sphinx-doc.org/";>Sphinx</a> 8.0.2.<br>
</p>
</div>
diff --git a/user-guide/operators.html b/user-guide/operators.html
index c6c2dc79..10965aa6 100644
--- a/user-guide/operators.html
+++ b/user-guide/operators.html
@@ -400,7 +400,7 @@ not supported by Comet will fall back to regular Spark
execution.</p>
<div class="footer-item">
<p class="sphinx-version">
-Created using <a href="http://sphinx-doc.org/";>Sphinx</a> 7.4.7.<br>
+Created using <a href="http://sphinx-doc.org/";>Sphinx</a> 8.0.2.<br>
</p>
</div>
diff --git a/user-guide/overview.html b/user-guide/overview.html
index f80272bf..58fc53d5 100644
--- a/user-guide/overview.html
+++ b/user-guide/overview.html
@@ -416,7 +416,7 @@ enabled.</p>
<div class="footer-item">
<p class="sphinx-version">
-Created using <a href="http://sphinx-doc.org/";>Sphinx</a> 7.4.7.<br>
+Created using <a href="http://sphinx-doc.org/";>Sphinx</a> 8.0.2.<br>
</p>
</div>
diff --git a/user-guide/tuning.html b/user-guide/tuning.html
index eb43ecd2..74c6f122 100644
--- a/user-guide/tuning.html
+++ b/user-guide/tuning.html
@@ -445,7 +445,7 @@ To enable native shuffle, just set <code class="docutils
literal notranslate"><s
<div class="footer-item">
<p class="sphinx-version">
-Created using <a href="http://sphinx-doc.org/";>Sphinx</a> 7.4.7.<br>
+Created using <a href="http://sphinx-doc.org/";>Sphinx</a> 8.0.2.<br>
</p>
</div>
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
