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/arrow-datafusion.git
The following commit(s) were added to refs/heads/asf-site by this push:
new 8685fad47a Publish built docs triggered by
e23d34bae60bb2f9c496241e218bab795af3af83
8685fad47a is described below
commit 8685fad47a4ab10206e177596ed44b8e78102e0a
Author: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
AuthorDate: Sat Oct 7 11:01:28 2023 +0000
Publish built docs triggered by e23d34bae60bb2f9c496241e218bab795af3af83
---
_sources/user-guide/cli.md.txt | 29 +++++++++++---
searchindex.js | 2 +-
user-guide/cli.html | 88 ++++++++++++++++++++++++------------------
3 files changed, 75 insertions(+), 44 deletions(-)
diff --git a/_sources/user-guide/cli.md.txt b/_sources/user-guide/cli.md.txt
index 05b4165e61..e8fdae7bb0 100644
--- a/_sources/user-guide/cli.md.txt
+++ b/_sources/user-guide/cli.md.txt
@@ -397,11 +397,13 @@ Available commands inside DataFusion CLI are:
- Show configuration options
+`SHOW ALL [VERBOSE]`
+
```SQL
> show all;
+-------------------------------------------------+---------+
-| name | setting |
+| name | value |
+-------------------------------------------------+---------+
| datafusion.execution.batch_size | 8192 |
| datafusion.execution.coalesce_batches | true |
@@ -414,6 +416,21 @@ Available commands inside DataFusion CLI are:
```
+- Show specific configuration option
+
+`SHOW xyz.abc.qwe [VERBOSE]`
+
+```SQL
+> show datafusion.execution.batch_size;
+
++-------------------------------------------------+---------+
+| name | value |
++-------------------------------------------------+---------+
+| datafusion.execution.batch_size | 8192 |
++-------------------------------------------------+---------+
+
+```
+
- Set configuration options
```SQL
@@ -432,12 +449,12 @@ For example, to set `datafusion.execution.batch_size` to
`1024` you
would set the `DATAFUSION_EXECUTION_BATCH_SIZE` environment variable
appropriately:
-```shell
+```SQL
$ DATAFUSION_EXECUTION_BATCH_SIZE=1024 datafusion-cli
DataFusion CLI v12.0.0
❯ show all;
+-------------------------------------------------+---------+
-| name | setting |
+| name | value |
+-------------------------------------------------+---------+
| datafusion.execution.batch_size | 1024 |
| datafusion.execution.coalesce_batches | true |
@@ -452,13 +469,13 @@ DataFusion CLI v12.0.0
You can change the configuration options using `SET` statement as well
-```shell
+```SQL
$ datafusion-cli
DataFusion CLI v13.0.0
❯ show datafusion.execution.batch_size;
+---------------------------------+---------+
-| name | setting |
+| name | value |
+---------------------------------+---------+
| datafusion.execution.batch_size | 8192 |
+---------------------------------+---------+
@@ -469,7 +486,7 @@ DataFusion CLI v13.0.0
❯ show datafusion.execution.batch_size;
+---------------------------------+---------+
-| name | setting |
+| name | value |
+---------------------------------+---------+
| datafusion.execution.batch_size | 1024 |
+---------------------------------+---------+
diff --git a/searchindex.js b/searchindex.js
index bec90eef62..03a5629dcd 100644
--- a/searchindex.js
+++ b/searchindex.js
@@ -1 +1 @@
-Search.setIndex({"docnames": ["contributor-guide/architecture",
"contributor-guide/communication", "contributor-guide/index",
"contributor-guide/quarterly_roadmap", "contributor-guide/roadmap",
"contributor-guide/specification/index",
"contributor-guide/specification/invariants",
"contributor-guide/specification/output-field-name-semantic", "index",
"library-user-guide/adding-udfs", "library-user-guide/building-logical-plans",
"library-user-guide/catalogs", "library-user-guide/custom-tab [...]
\ No newline at end of file
+Search.setIndex({"docnames": ["contributor-guide/architecture",
"contributor-guide/communication", "contributor-guide/index",
"contributor-guide/quarterly_roadmap", "contributor-guide/roadmap",
"contributor-guide/specification/index",
"contributor-guide/specification/invariants",
"contributor-guide/specification/output-field-name-semantic", "index",
"library-user-guide/adding-udfs", "library-user-guide/building-logical-plans",
"library-user-guide/catalogs", "library-user-guide/custom-tab [...]
\ No newline at end of file
diff --git a/user-guide/cli.html b/user-guide/cli.html
index 035f146c77..f7e9f033ef 100644
--- a/user-guide/cli.html
+++ b/user-guide/cli.html
@@ -822,10 +822,11 @@ DataFusion<span class="w"> </span>CLI<span class="w">
</span>v21.0.0
<ul class="simple">
<li><p>Show configuration options</p></li>
</ul>
+<p><code class="docutils literal notranslate"><span class="pre">SHOW</span>
<span class="pre">ALL</span> <span class="pre">[VERBOSE]</span></code></p>
<div class="highlight-SQL notranslate"><div
class="highlight"><pre><span></span><span class="o">></span><span class="w">
</span><span class="k">show</span><span class="w"> </span><span
class="k">all</span><span class="p">;</span>
<span class="o">+</span><span
class="c1">-------------------------------------------------+---------+</span>
-<span class="o">|</span><span class="w"> </span><span
class="n">name</span><span class="w">
</span><span class="o">|</span><span class="w"> </span><span
class="n">setting</span><span class="w"> </span><span class="o">|</span>
+<span class="o">|</span><span class="w"> </span><span
class="n">name</span><span class="w">
</span><span class="o">|</span><span class="w"> </span><span
class="n">value</span><span class="w"> </span><span class="o">|</span>
<span class="o">+</span><span
class="c1">-------------------------------------------------+---------+</span>
<span class="o">|</span><span class="w"> </span><span
class="n">datafusion</span><span class="p">.</span><span
class="n">execution</span><span class="p">.</span><span
class="n">batch_size</span><span class="w"> </span><span
class="o">|</span><span class="w"> </span><span class="mi">8192</span><span
class="w"> </span><span class="o">|</span>
<span class="o">|</span><span class="w"> </span><span
class="n">datafusion</span><span class="p">.</span><span
class="n">execution</span><span class="p">.</span><span
class="n">coalesce_batches</span><span class="w"> </span><span
class="o">|</span><span class="w"> </span><span class="k">true</span><span
class="w"> </span><span class="o">|</span>
@@ -838,6 +839,19 @@ DataFusion<span class="w"> </span>CLI<span class="w">
</span>v21.0.0
</pre></div>
</div>
<ul class="simple">
+<li><p>Show specific configuration option</p></li>
+</ul>
+<p><code class="docutils literal notranslate"><span class="pre">SHOW</span>
<span class="pre">xyz.abc.qwe</span> <span
class="pre">[VERBOSE]</span></code></p>
+<div class="highlight-SQL notranslate"><div
class="highlight"><pre><span></span><span class="o">></span><span class="w">
</span><span class="k">show</span><span class="w"> </span><span
class="n">datafusion</span><span class="p">.</span><span
class="n">execution</span><span class="p">.</span><span
class="n">batch_size</span><span class="p">;</span>
+
+<span class="o">+</span><span
class="c1">-------------------------------------------------+---------+</span>
+<span class="o">|</span><span class="w"> </span><span
class="n">name</span><span class="w">
</span><span class="o">|</span><span class="w"> </span><span
class="n">value</span><span class="w"> </span><span class="o">|</span>
+<span class="o">+</span><span
class="c1">-------------------------------------------------+---------+</span>
+<span class="o">|</span><span class="w"> </span><span
class="n">datafusion</span><span class="p">.</span><span
class="n">execution</span><span class="p">.</span><span
class="n">batch_size</span><span class="w"> </span><span
class="o">|</span><span class="w"> </span><span class="mi">8192</span><span
class="w"> </span><span class="o">|</span>
+<span class="o">+</span><span
class="c1">-------------------------------------------------+---------+</span>
+</pre></div>
+</div>
+<ul class="simple">
<li><p>Set configuration options</p></li>
</ul>
<div class="highlight-SQL notranslate"><div
class="highlight"><pre><span></span><span class="o">></span><span class="w">
</span><span class="k">SET</span><span class="w"> </span><span
class="n">datafusion</span><span class="p">.</span><span
class="n">execution</span><span class="p">.</span><span
class="n">batch_size</span><span class="w"> </span><span
class="k">to</span><span class="w"> </span><span class="mi">1024</span><span
class="p">;</span>
@@ -853,45 +867,45 @@ variable with an upper case name and all <code
class="docutils literal notransla
<p>For example, to set <code class="docutils literal notranslate"><span
class="pre">datafusion.execution.batch_size</span></code> to <code
class="docutils literal notranslate"><span class="pre">1024</span></code> you
would set the <code class="docutils literal notranslate"><span
class="pre">DATAFUSION_EXECUTION_BATCH_SIZE</span></code> environment variable
appropriately:</p>
-<div class="highlight-shell notranslate"><div
class="highlight"><pre><span></span>$<span class="w"> </span><span
class="nv">DATAFUSION_EXECUTION_BATCH_SIZE</span><span class="o">=</span><span
class="m">1024</span><span class="w"> </span>datafusion-cli
-DataFusion<span class="w"> </span>CLI<span class="w"> </span>v12.0.0
-❯<span class="w"> </span>show<span class="w"> </span>all<span
class="p">;</span>
-+-------------------------------------------------+---------+
-<span class="p">|</span><span class="w"> </span>name<span class="w">
</span><span class="p">|</span><span
class="w"> </span>setting<span class="w"> </span><span class="p">|</span>
-+-------------------------------------------------+---------+
-<span class="p">|</span><span class="w">
</span>datafusion.execution.batch_size<span class="w">
</span><span class="p">|</span><span class="w"> </span><span
class="m">1024</span><span class="w"> </span><span class="p">|</span>
-<span class="p">|</span><span class="w">
</span>datafusion.execution.coalesce_batches<span class="w">
</span><span class="p">|</span><span class="w"> </span><span
class="nb">true</span><span class="w"> </span><span class="p">|</span>
-<span class="p">|</span><span class="w">
</span>datafusion.execution.time_zone<span class="w">
</span><span class="p">|</span><span class="w"> </span>UTC<span class="w">
</span><span class="p">|</span>
-<span class="p">|</span><span class="w">
</span>datafusion.explain.logical_plan_only<span class="w">
</span><span class="p">|</span><span class="w"> </span><span
class="nb">false</span><span class="w"> </span><span class="p">|</span>
-<span class="p">|</span><span class="w">
</span>datafusion.explain.physical_plan_only<span class="w">
</span><span class="p">|</span><span class="w"> </span><span
class="nb">false</span><span class="w"> </span><span class="p">|</span>
-<span class="p">|</span><span class="w">
</span>datafusion.optimizer.filter_null_join_keys<span class="w">
</span><span class="p">|</span><span class="w"> </span><span
class="nb">false</span><span class="w"> </span><span class="p">|</span>
-<span class="p">|</span><span class="w">
</span>datafusion.optimizer.skip_failed_rules<span class="w">
</span><span class="p">|</span><span class="w"> </span><span
class="nb">true</span><span class="w"> </span><span class="p">|</span>
-+-------------------------------------------------+---------+
-<span class="m">8</span><span class="w"> </span>rows<span class="w">
</span><span class="k">in</span><span class="w"> </span>set.<span class="w">
</span>Query<span class="w"> </span>took<span class="w"> </span><span
class="m">0</span>.002<span class="w"> </span>seconds.
+<div class="highlight-SQL notranslate"><div
class="highlight"><pre><span></span><span class="err">$</span><span class="w">
</span><span class="n">DATAFUSION_EXECUTION_BATCH_SIZE</span><span
class="o">=</span><span class="mi">1024</span><span class="w"> </span><span
class="n">datafusion</span><span class="o">-</span><span class="n">cli</span>
+<span class="n">DataFusion</span><span class="w"> </span><span
class="n">CLI</span><span class="w"> </span><span class="n">v12</span><span
class="p">.</span><span class="mi">0</span><span class="p">.</span><span
class="mi">0</span>
+<span class="err">❯</span><span class="w"> </span><span
class="k">show</span><span class="w"> </span><span class="k">all</span><span
class="p">;</span>
+<span class="o">+</span><span
class="c1">-------------------------------------------------+---------+</span>
+<span class="o">|</span><span class="w"> </span><span
class="n">name</span><span class="w">
</span><span class="o">|</span><span class="w"> </span><span
class="n">value</span><span class="w"> </span><span class="o">|</span>
+<span class="o">+</span><span
class="c1">-------------------------------------------------+---------+</span>
+<span class="o">|</span><span class="w"> </span><span
class="n">datafusion</span><span class="p">.</span><span
class="n">execution</span><span class="p">.</span><span
class="n">batch_size</span><span class="w"> </span><span
class="o">|</span><span class="w"> </span><span class="mi">1024</span><span
class="w"> </span><span class="o">|</span>
+<span class="o">|</span><span class="w"> </span><span
class="n">datafusion</span><span class="p">.</span><span
class="n">execution</span><span class="p">.</span><span
class="n">coalesce_batches</span><span class="w"> </span><span
class="o">|</span><span class="w"> </span><span class="k">true</span><span
class="w"> </span><span class="o">|</span>
+<span class="o">|</span><span class="w"> </span><span
class="n">datafusion</span><span class="p">.</span><span
class="n">execution</span><span class="p">.</span><span
class="n">time_zone</span><span class="w"> </span><span
class="o">|</span><span class="w"> </span><span class="n">UTC</span><span
class="w"> </span><span class="o">|</span>
+<span class="o">|</span><span class="w"> </span><span
class="n">datafusion</span><span class="p">.</span><span
class="k">explain</span><span class="p">.</span><span
class="n">logical_plan_only</span><span class="w"> </span><span
class="o">|</span><span class="w"> </span><span class="k">false</span><span
class="w"> </span><span class="o">|</span>
+<span class="o">|</span><span class="w"> </span><span
class="n">datafusion</span><span class="p">.</span><span
class="k">explain</span><span class="p">.</span><span
class="n">physical_plan_only</span><span class="w"> </span><span
class="o">|</span><span class="w"> </span><span class="k">false</span><span
class="w"> </span><span class="o">|</span>
+<span class="o">|</span><span class="w"> </span><span
class="n">datafusion</span><span class="p">.</span><span
class="n">optimizer</span><span class="p">.</span><span
class="n">filter_null_join_keys</span><span class="w"> </span><span
class="o">|</span><span class="w"> </span><span class="k">false</span><span
class="w"> </span><span class="o">|</span>
+<span class="o">|</span><span class="w"> </span><span
class="n">datafusion</span><span class="p">.</span><span
class="n">optimizer</span><span class="p">.</span><span
class="n">skip_failed_rules</span><span class="w"> </span><span
class="o">|</span><span class="w"> </span><span class="k">true</span><span
class="w"> </span><span class="o">|</span>
+<span class="o">+</span><span
class="c1">-------------------------------------------------+---------+</span>
+<span class="mi">8</span><span class="w"> </span><span
class="k">rows</span><span class="w"> </span><span class="k">in</span><span
class="w"> </span><span class="k">set</span><span class="p">.</span><span
class="w"> </span><span class="n">Query</span><span class="w"> </span><span
class="n">took</span><span class="w"> </span><span class="mi">0</span><span
class="p">.</span><span class="mi">002</span><span class="w"> </span><span
class="n">seconds</span><span class="p">.</span>
</pre></div>
</div>
<p>You can change the configuration options using <code class="docutils
literal notranslate"><span class="pre">SET</span></code> statement as well</p>
-<div class="highlight-shell notranslate"><div
class="highlight"><pre><span></span>$<span class="w"> </span>datafusion-cli
-DataFusion<span class="w"> </span>CLI<span class="w"> </span>v13.0.0
-
-❯<span class="w"> </span>show<span class="w">
</span>datafusion.execution.batch_size<span class="p">;</span>
-+---------------------------------+---------+
-<span class="p">|</span><span class="w"> </span>name<span class="w">
</span><span class="p">|</span><span class="w">
</span>setting<span class="w"> </span><span class="p">|</span>
-+---------------------------------+---------+
-<span class="p">|</span><span class="w">
</span>datafusion.execution.batch_size<span class="w"> </span><span
class="p">|</span><span class="w"> </span><span class="m">8192</span><span
class="w"> </span><span class="p">|</span>
-+---------------------------------+---------+
-<span class="m">1</span><span class="w"> </span>row<span class="w">
</span><span class="k">in</span><span class="w"> </span>set.<span class="w">
</span>Query<span class="w"> </span>took<span class="w"> </span><span
class="m">0</span>.011<span class="w"> </span>seconds.
-
-❯<span class="w"> </span><span class="nb">set</span><span class="w">
</span>datafusion.execution.batch_size<span class="w"> </span>to<span
class="w"> </span><span class="m">1024</span><span class="p">;</span>
-<span class="m">0</span><span class="w"> </span>rows<span class="w">
</span><span class="k">in</span><span class="w"> </span>set.<span class="w">
</span>Query<span class="w"> </span>took<span class="w"> </span><span
class="m">0</span>.000<span class="w"> </span>seconds.
-
-❯<span class="w"> </span>show<span class="w">
</span>datafusion.execution.batch_size<span class="p">;</span>
-+---------------------------------+---------+
-<span class="p">|</span><span class="w"> </span>name<span class="w">
</span><span class="p">|</span><span class="w">
</span>setting<span class="w"> </span><span class="p">|</span>
-+---------------------------------+---------+
-<span class="p">|</span><span class="w">
</span>datafusion.execution.batch_size<span class="w"> </span><span
class="p">|</span><span class="w"> </span><span class="m">1024</span><span
class="w"> </span><span class="p">|</span>
-+---------------------------------+---------+
-<span class="m">1</span><span class="w"> </span>row<span class="w">
</span><span class="k">in</span><span class="w"> </span>set.<span class="w">
</span>Query<span class="w"> </span>took<span class="w"> </span><span
class="m">0</span>.005<span class="w"> </span>seconds.
+<div class="highlight-SQL notranslate"><div
class="highlight"><pre><span></span><span class="err">$</span><span class="w">
</span><span class="n">datafusion</span><span class="o">-</span><span
class="n">cli</span>
+<span class="n">DataFusion</span><span class="w"> </span><span
class="n">CLI</span><span class="w"> </span><span class="n">v13</span><span
class="p">.</span><span class="mi">0</span><span class="p">.</span><span
class="mi">0</span>
+
+<span class="err">❯</span><span class="w"> </span><span
class="k">show</span><span class="w"> </span><span
class="n">datafusion</span><span class="p">.</span><span
class="n">execution</span><span class="p">.</span><span
class="n">batch_size</span><span class="p">;</span>
+<span class="o">+</span><span
class="c1">---------------------------------+---------+</span>
+<span class="o">|</span><span class="w"> </span><span
class="n">name</span><span class="w"> </span><span
class="o">|</span><span class="w"> </span><span class="n">value</span><span
class="w"> </span><span class="o">|</span>
+<span class="o">+</span><span
class="c1">---------------------------------+---------+</span>
+<span class="o">|</span><span class="w"> </span><span
class="n">datafusion</span><span class="p">.</span><span
class="n">execution</span><span class="p">.</span><span
class="n">batch_size</span><span class="w"> </span><span
class="o">|</span><span class="w"> </span><span class="mi">8192</span><span
class="w"> </span><span class="o">|</span>
+<span class="o">+</span><span
class="c1">---------------------------------+---------+</span>
+<span class="mi">1</span><span class="w"> </span><span
class="k">row</span><span class="w"> </span><span class="k">in</span><span
class="w"> </span><span class="k">set</span><span class="p">.</span><span
class="w"> </span><span class="n">Query</span><span class="w"> </span><span
class="n">took</span><span class="w"> </span><span class="mi">0</span><span
class="p">.</span><span class="mi">011</span><span class="w"> </span><span
class="n">seconds</span><span class="p">.</span>
+
+<span class="err">❯</span><span class="w"> </span><span
class="k">set</span><span class="w"> </span><span
class="n">datafusion</span><span class="p">.</span><span
class="n">execution</span><span class="p">.</span><span
class="n">batch_size</span><span class="w"> </span><span
class="k">to</span><span class="w"> </span><span class="mi">1024</span><span
class="p">;</span>
+<span class="mi">0</span><span class="w"> </span><span
class="k">rows</span><span class="w"> </span><span class="k">in</span><span
class="w"> </span><span class="k">set</span><span class="p">.</span><span
class="w"> </span><span class="n">Query</span><span class="w"> </span><span
class="n">took</span><span class="w"> </span><span class="mi">0</span><span
class="p">.</span><span class="mi">000</span><span class="w"> </span><span
class="n">seconds</span><span class="p">.</span>
+
+<span class="err">❯</span><span class="w"> </span><span
class="k">show</span><span class="w"> </span><span
class="n">datafusion</span><span class="p">.</span><span
class="n">execution</span><span class="p">.</span><span
class="n">batch_size</span><span class="p">;</span>
+<span class="o">+</span><span
class="c1">---------------------------------+---------+</span>
+<span class="o">|</span><span class="w"> </span><span
class="n">name</span><span class="w"> </span><span
class="o">|</span><span class="w"> </span><span class="n">value</span><span
class="w"> </span><span class="o">|</span>
+<span class="o">+</span><span
class="c1">---------------------------------+---------+</span>
+<span class="o">|</span><span class="w"> </span><span
class="n">datafusion</span><span class="p">.</span><span
class="n">execution</span><span class="p">.</span><span
class="n">batch_size</span><span class="w"> </span><span
class="o">|</span><span class="w"> </span><span class="mi">1024</span><span
class="w"> </span><span class="o">|</span>
+<span class="o">+</span><span
class="c1">---------------------------------+---------+</span>
+<span class="mi">1</span><span class="w"> </span><span
class="k">row</span><span class="w"> </span><span class="k">in</span><span
class="w"> </span><span class="k">set</span><span class="p">.</span><span
class="w"> </span><span class="n">Query</span><span class="w"> </span><span
class="n">took</span><span class="w"> </span><span class="mi">0</span><span
class="p">.</span><span class="mi">005</span><span class="w"> </span><span
class="n">seconds</span><span class="p">.</span>
</pre></div>
</div>
</section>
