You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@datafusion.apache.org by gi...@apache.org on 2024/08/27 14:39:10 UTC
(datafusion-comet) branch asf-site updated: Publish built docs triggered by 3d1dbb03eff2ead2f863371b6d93c9073f3619b4
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 c338383c Publish built docs triggered by 3d1dbb03eff2ead2f863371b6d93c9073f3619b4
c338383c is described below
commit c338383ca191a9c07e4812b63f1e6cddd16b6d28
Author: github-actions[bot] <gi...@users.noreply.github.com>
AuthorDate: Tue Aug 27 14:39:07 2024 +0000
Publish built docs triggered by 3d1dbb03eff2ead2f863371b6d93c9073f3619b4
---
_sources/user-guide/configs.md.txt | 1 +
_sources/user-guide/datasources.md.txt | 5 ++
searchindex.js | 2 +-
user-guide/configs.html | 84 ++++++++++++++++++----------------
user-guide/datasources.html | 10 ++++
5 files changed, 61 insertions(+), 41 deletions(-)
diff --git a/_sources/user-guide/configs.md.txt b/_sources/user-guide/configs.md.txt
index d23e4c71..0679bacb 100644
--- a/_sources/user-guide/configs.md.txt
+++ b/_sources/user-guide/configs.md.txt
@@ -30,6 +30,7 @@ Comet provides the following configuration settings.
| spark.comet.columnar.shuffle.async.max.thread.num | Maximum number of threads on an executor used for Comet async columnar shuffle. By default, this config is 100. This is the upper bound of total number of shuffle threads per executor. In other words, if the number of cores * the number of shuffle threads per task `spark.comet.columnar.shuffle.async.thread.num` is larger than this config. Comet will use this config as the number of shuffle threads per executor instead. | 100 |
| spark.comet.columnar.shuffle.async.thread.num | Number of threads used for Comet async columnar shuffle per shuffle task. By default, this config is 3. Note that more threads means more memory requirement to buffer shuffle data before flushing to disk. Also, more threads may not always improve performance, and should be set based on the number of cores available. | 3 |
| spark.comet.columnar.shuffle.memory.factor | Fraction of Comet memory to be allocated per executor process for Comet shuffle. Comet memory size is specified by `spark.comet.memoryOverhead` or calculated by `spark.comet.memory.overhead.factor` * `spark.executor.memory`. By default, this config is 1.0. | 1.0 |
+| spark.comet.convert.csv.enabled | When enabled, data from Spark (non-native) CSV v1 and v2 scans will be converted to Arrow format. Note that to enable native vectorized execution, both this config and 'spark.comet.exec.enabled' need to be enabled. | false |
| spark.comet.convert.json.enabled | When enabled, data from Spark (non-native) JSON v1 and v2 scans will be converted to Arrow format. Note that to enable native vectorized execution, both this config and 'spark.comet.exec.enabled' need to be enabled. | false |
| spark.comet.convert.parquet.enabled | When enabled, data from Spark (non-native) Parquet v1 and v2 scans will be converted to Arrow format. Note that to enable native vectorized execution, both this config and 'spark.comet.exec.enabled' need to be enabled. | false |
| spark.comet.debug.enabled | Whether to enable debug mode for Comet. By default, this config is false. When enabled, Comet will do additional checks for debugging purpose. For example, validating array when importing arrays from JVM at native side. Note that these checks may be expensive in performance and should only be enabled for debugging purpose. | false |
diff --git a/_sources/user-guide/datasources.md.txt b/_sources/user-guide/datasources.md.txt
index 92c13f67..9607ba60 100644
--- a/_sources/user-guide/datasources.md.txt
+++ b/_sources/user-guide/datasources.md.txt
@@ -26,6 +26,11 @@ in the schema are supported. When this option is not enabled, the scan will fall
enabling `spark.comet.convert.parquet.enabled` will immediately convert the data into Arrow format, allowing native
execution to happen after that, but the process may not be efficient.
+## CSV
+
+Comet does not provide native CSV scan, but when `spark.comet.convert.csv.enabled` is enabled, data is immediately
+converted into Arrow format, allowing native execution to happen after that.
+
## JSON
Comet does not provide native JSON scan, but when `spark.comet.convert.json.enabled` is enabled, data is immediately
diff --git a/searchindex.js b/searchindex.js
index 1399dc4a..3b4ce32d 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/configs.html b/user-guide/configs.html
index 80282821..adbebab3 100644
--- a/user-guide/configs.html
+++ b/user-guide/configs.html
@@ -351,163 +351,167 @@ under the License.
<td><p>Fraction of Comet memory to be allocated per executor process for Comet shuffle. Comet memory size is specified by <code class="docutils literal notranslate"><span class="pre">spark.comet.memoryOverhead</span></code> or calculated by <code class="docutils literal notranslate"><span class="pre">spark.comet.memory.overhead.factor</span></code> * <code class="docutils literal notranslate"><span class="pre">spark.executor.memory</span></code>. By default, this config is 1.0.</p></td>
<td><p>1.0</p></td>
</tr>
-<tr class="row-odd"><td><p>spark.comet.convert.json.enabled</p></td>
+<tr class="row-odd"><td><p>spark.comet.convert.csv.enabled</p></td>
+<td><p>When enabled, data from Spark (non-native) CSV v1 and v2 scans will be converted to Arrow format. Note that to enable native vectorized execution, both this config and ‘spark.comet.exec.enabled’ need to be enabled.</p></td>
+<td><p>false</p></td>
+</tr>
+<tr class="row-even"><td><p>spark.comet.convert.json.enabled</p></td>
<td><p>When enabled, data from Spark (non-native) JSON v1 and v2 scans will be converted to Arrow format. Note that to enable native vectorized execution, both this config and ‘spark.comet.exec.enabled’ need to be enabled.</p></td>
<td><p>false</p></td>
</tr>
-<tr class="row-even"><td><p>spark.comet.convert.parquet.enabled</p></td>
+<tr class="row-odd"><td><p>spark.comet.convert.parquet.enabled</p></td>
<td><p>When enabled, data from Spark (non-native) Parquet v1 and v2 scans will be converted to Arrow format. Note that to enable native vectorized execution, both this config and ‘spark.comet.exec.enabled’ need to be enabled.</p></td>
<td><p>false</p></td>
</tr>
-<tr class="row-odd"><td><p>spark.comet.debug.enabled</p></td>
+<tr class="row-even"><td><p>spark.comet.debug.enabled</p></td>
<td><p>Whether to enable debug mode for Comet. By default, this config is false. When enabled, Comet will do additional checks for debugging purpose. For example, validating array when importing arrays from JVM at native side. Note that these checks may be expensive in performance and should only be enabled for debugging purpose.</p></td>
<td><p>false</p></td>
</tr>
-<tr class="row-even"><td><p>spark.comet.enabled</p></td>
+<tr class="row-odd"><td><p>spark.comet.enabled</p></td>
<td><p>Whether to enable Comet extension for Spark. 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 the value of the env var <code class="docutils literal notranslate"><span class="pre">ENABLE_COMET</span></code> if set, or true otherwise.</p></td>
<td><p>true</p></td>
</tr>
-<tr class="row-odd"><td><p>spark.comet.exceptionOnDatetimeRebase</p></td>
+<tr class="row-even"><td><p>spark.comet.exceptionOnDatetimeRebase</p></td>
<td><p>Whether to throw exception when seeing dates/timestamps from the legacy hybrid (Julian + Gregorian) calendar. Since Spark 3, dates/timestamps were written according to the Proleptic Gregorian calendar. When this is true, Comet will throw exceptions when seeing these dates/timestamps that were written by Spark version before 3.0. If this is false, these dates/timestamps will be read as if they were written to the Proleptic Gregorian calendar and will not be rebased.</p></td>
<td><p>false</p></td>
</tr>
-<tr class="row-even"><td><p>spark.comet.exec.aggregate.enabled</p></td>
+<tr class="row-odd"><td><p>spark.comet.exec.aggregate.enabled</p></td>
<td><p>Whether to enable aggregate by default.</p></td>
<td><p>true</p></td>
</tr>
-<tr class="row-odd"><td><p>spark.comet.exec.broadcastExchange.enabled</p></td>
+<tr class="row-even"><td><p>spark.comet.exec.broadcastExchange.enabled</p></td>
<td><p>Whether to enable broadcastExchange by default.</p></td>
<td><p>true</p></td>
</tr>
-<tr class="row-even"><td><p>spark.comet.exec.broadcastHashJoin.enabled</p></td>
+<tr class="row-odd"><td><p>spark.comet.exec.broadcastHashJoin.enabled</p></td>
<td><p>Whether to enable broadcastHashJoin by default.</p></td>
<td><p>true</p></td>
</tr>
-<tr class="row-odd"><td><p>spark.comet.exec.coalesce.enabled</p></td>
+<tr class="row-even"><td><p>spark.comet.exec.coalesce.enabled</p></td>
<td><p>Whether to enable coalesce by default.</p></td>
<td><p>true</p></td>
</tr>
-<tr class="row-even"><td><p>spark.comet.exec.collectLimit.enabled</p></td>
+<tr class="row-odd"><td><p>spark.comet.exec.collectLimit.enabled</p></td>
<td><p>Whether to enable collectLimit by default.</p></td>
<td><p>true</p></td>
</tr>
-<tr class="row-odd"><td><p>spark.comet.exec.enabled</p></td>
+<tr class="row-even"><td><p>spark.comet.exec.enabled</p></td>
<td><p>Whether to enable Comet native vectorized execution for Spark. This controls whether Spark should convert operators into their Comet counterparts and execute them in native space. Note: each operator is associated with a separate config in the format of ‘spark.comet.exec.<operator_name>.enabled’ at the moment, and both the config and this need to be turned on, in order for the operator to be executed in native. By default, this config is true.</p></td>
<td><p>true</p></td>
</tr>
-<tr class="row-even"><td><p>spark.comet.exec.expand.enabled</p></td>
+<tr class="row-odd"><td><p>spark.comet.exec.expand.enabled</p></td>
<td><p>Whether to enable expand by default.</p></td>
<td><p>true</p></td>
</tr>
-<tr class="row-odd"><td><p>spark.comet.exec.filter.enabled</p></td>
+<tr class="row-even"><td><p>spark.comet.exec.filter.enabled</p></td>
<td><p>Whether to enable filter by default.</p></td>
<td><p>true</p></td>
</tr>
-<tr class="row-even"><td><p>spark.comet.exec.globalLimit.enabled</p></td>
+<tr class="row-odd"><td><p>spark.comet.exec.globalLimit.enabled</p></td>
<td><p>Whether to enable globalLimit by default.</p></td>
<td><p>true</p></td>
</tr>
-<tr class="row-odd"><td><p>spark.comet.exec.hashJoin.enabled</p></td>
+<tr class="row-even"><td><p>spark.comet.exec.hashJoin.enabled</p></td>
<td><p>Whether to enable hashJoin by default.</p></td>
<td><p>true</p></td>
</tr>
-<tr class="row-even"><td><p>spark.comet.exec.localLimit.enabled</p></td>
+<tr class="row-odd"><td><p>spark.comet.exec.localLimit.enabled</p></td>
<td><p>Whether to enable localLimit by default.</p></td>
<td><p>true</p></td>
</tr>
-<tr class="row-odd"><td><p>spark.comet.exec.memoryFraction</p></td>
+<tr class="row-even"><td><p>spark.comet.exec.memoryFraction</p></td>
<td><p>The fraction of memory from Comet memory overhead that the native memory manager can use for execution. The purpose of this config is to set aside memory for untracked data structures, as well as imprecise size estimation during memory acquisition. Default value is 0.7.</p></td>
<td><p>0.7</p></td>
</tr>
-<tr class="row-even"><td><p>spark.comet.exec.project.enabled</p></td>
+<tr class="row-odd"><td><p>spark.comet.exec.project.enabled</p></td>
<td><p>Whether to enable project by default.</p></td>
<td><p>true</p></td>
</tr>
-<tr class="row-odd"><td><p>spark.comet.exec.shuffle.codec</p></td>
+<tr class="row-even"><td><p>spark.comet.exec.shuffle.codec</p></td>
<td><p>The codec of Comet native shuffle used to compress shuffle data. Only zstd is supported.</p></td>
<td><p>zstd</p></td>
</tr>
-<tr class="row-even"><td><p>spark.comet.exec.shuffle.enabled</p></td>
+<tr class="row-odd"><td><p>spark.comet.exec.shuffle.enabled</p></td>
<td><p>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.</p></td>
<td><p>false</p></td>
</tr>
-<tr class="row-odd"><td><p>spark.comet.exec.shuffle.mode</p></td>
+<tr class="row-even"><td><p>spark.comet.exec.shuffle.mode</p></td>
<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.exec.sort.enabled</p></td>
+<tr class="row-odd"><td><p>spark.comet.exec.sort.enabled</p></td>
<td><p>Whether to enable sort by default.</p></td>
<td><p>true</p></td>
</tr>
-<tr class="row-odd"><td><p>spark.comet.exec.sortMergeJoin.enabled</p></td>
+<tr class="row-even"><td><p>spark.comet.exec.sortMergeJoin.enabled</p></td>
<td><p>Whether to enable sortMergeJoin by default.</p></td>
<td><p>true</p></td>
</tr>
-<tr class="row-even"><td><p>spark.comet.exec.stddev.enabled</p></td>
+<tr class="row-odd"><td><p>spark.comet.exec.stddev.enabled</p></td>
<td><p>Whether to enable stddev by default. stddev is slower than Spark’s implementation.</p></td>
<td><p>true</p></td>
</tr>
-<tr class="row-odd"><td><p>spark.comet.exec.takeOrderedAndProject.enabled</p></td>
+<tr class="row-even"><td><p>spark.comet.exec.takeOrderedAndProject.enabled</p></td>
<td><p>Whether to enable takeOrderedAndProject by default.</p></td>
<td><p>true</p></td>
</tr>
-<tr class="row-even"><td><p>spark.comet.exec.union.enabled</p></td>
+<tr class="row-odd"><td><p>spark.comet.exec.union.enabled</p></td>
<td><p>Whether to enable union by default.</p></td>
<td><p>true</p></td>
</tr>
-<tr class="row-odd"><td><p>spark.comet.exec.window.enabled</p></td>
+<tr class="row-even"><td><p>spark.comet.exec.window.enabled</p></td>
<td><p>Whether to enable window by default.</p></td>
<td><p>true</p></td>
</tr>
-<tr class="row-even"><td><p>spark.comet.explain.native.enabled</p></td>
+<tr class="row-odd"><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>
+<tr class="row-even"><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-even"><td><p>spark.comet.explainFallback.enabled</p></td>
+<tr class="row-odd"><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-odd"><td><p>spark.comet.memory.overhead.factor</p></td>
+<tr class="row-even"><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-even"><td><p>spark.comet.memory.overhead.min</p></td>
+<tr class="row-odd"><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-odd"><td><p>spark.comet.nativeLoadRequired</p></td>
+<tr class="row-even"><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-even"><td><p>spark.comet.parquet.enable.directBuffer</p></td>
+<tr class="row-odd"><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-odd"><td><p>spark.comet.regexp.allowIncompatible</p></td>
+<tr class="row-even"><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-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 native scans. When this is turned on, Spark will use Comet to read supported data sources (currently only Parquet is supported natively). 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>
-<tr class="row-even"><td><p>spark.comet.sparkToColumnar.supportedOperatorList</p></td>
+<tr class="row-odd"><td><p>spark.comet.sparkToColumnar.supportedOperatorList</p></td>
<td><p>A comma-separated list of operators that will be converted to Arrow columnar format when ‘spark.comet.sparkToColumnar.enabled’ is true</p></td>
<td><p>Range,InMemoryTableScan</p></td>
</tr>
diff --git a/user-guide/datasources.html b/user-guide/datasources.html
index 5193d69f..2d459507 100644
--- a/user-guide/datasources.html
+++ b/user-guide/datasources.html
@@ -276,6 +276,11 @@ under the License.
Parquet
</a>
</li>
+ <li class="toc-h2 nav-item toc-entry">
+ <a class="reference internal nav-link" href="#csv">
+ CSV
+ </a>
+ </li>
<li class="toc-h2 nav-item toc-entry">
<a class="reference internal nav-link" href="#json">
JSON
@@ -336,6 +341,11 @@ in the schema are supported. When this option is not enabled, the scan will fall
enabling <code class="docutils literal notranslate"><span class="pre">spark.comet.convert.parquet.enabled</span></code> will immediately convert the data into Arrow format, allowing native
execution to happen after that, but the process may not be efficient.</p>
</section>
+<section id="csv">
+<h2>CSV<a class="headerlink" href="#csv" title="Link to this heading">¶</a></h2>
+<p>Comet does not provide native CSV scan, but when <code class="docutils literal notranslate"><span class="pre">spark.comet.convert.csv.enabled</span></code> is enabled, data is immediately
+converted into Arrow format, allowing native execution to happen after that.</p>
+</section>
<section id="json">
<h2>JSON<a class="headerlink" href="#json" title="Link to this heading">¶</a></h2>
<p>Comet does not provide native JSON scan, but when <code class="docutils literal notranslate"><span class="pre">spark.comet.convert.json.enabled</span></code> is enabled, data is immediately
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@datafusion.apache.org
For additional commands, e-mail: commits-help@datafusion.apache.org