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 2026/04/27 14:26:37 UTC
(datafusion) branch asf-site updated: Publish built docs triggered by 68061a584ffb90a045c6a2f3a3f3720d40fbbc08
This is an automated email from the ASF dual-hosted git repository.
github-actions[bot] pushed a commit to branch asf-site
in repository https://gitbox.apache.org/repos/asf/datafusion.git
The following commit(s) were added to refs/heads/asf-site by this push:
new 2c4a02abd5 Publish built docs triggered by 68061a584ffb90a045c6a2f3a3f3720d40fbbc08
2c4a02abd5 is described below
commit 2c4a02abd53313c360f8df8281035252aa7dc520
Author: github-actions[bot] <gi...@users.noreply.github.com>
AuthorDate: Mon Apr 27 14:26:31 2026 +0000
Publish built docs triggered by 68061a584ffb90a045c6a2f3a3f3720d40fbbc08
---
_sources/user-guide/cli/usage.md.txt | 87 ++++++++++++++--------------------
searchindex.js | 2 +-
user-guide/cli/usage.html | 91 ++++++++++++++----------------------
3 files changed, 71 insertions(+), 109 deletions(-)
diff --git a/_sources/user-guide/cli/usage.md.txt b/_sources/user-guide/cli/usage.md.txt
index 7c56b994fc..75c6698f00 100644
--- a/_sources/user-guide/cli/usage.md.txt
+++ b/_sources/user-guide/cli/usage.md.txt
@@ -22,64 +22,45 @@
See the current usage using `datafusion-cli --help`:
```bash
-Apache Arrow <de...@arrow.apache.org>
Command Line Client for DataFusion query engine.
-USAGE:
- datafusion-cli [OPTIONS]
-
-OPTIONS:
- -b, --batch-size <BATCH_SIZE>
- The batch size of each query, or use DataFusion default
-
- -c, --command <COMMAND>...
- Execute the given command string(s), then exit
-
- --color
- Enables console syntax highlighting
-
- -f, --file <FILE>...
- Execute commands from file(s), then exit
-
- --format <FORMAT>
- [default: table] [possible values: csv, tsv, table, json, nd-json]
-
- -h, --help
- Print help information
-
- -m, --memory-limit <MEMORY_LIMIT>
- The memory pool limitation (e.g. '10g'), default to None (no limit)
-
- --maxrows <MAXROWS>
- The max number of rows to display for 'Table' format
- [possible values: numbers(0/10/...), inf(no limit)] [default: 40]
-
- --mem-pool-type <MEM_POOL_TYPE>
- Specify the memory pool type 'greedy' or 'fair', default to 'greedy'
-
- --top-memory-consumers <TOP_MEMORY_CONSUMERS>
- The number of top memory consumers to display when query fails due to memory exhaustion.
- To disable memory consumer tracking, set this value to 0 [default: 3].
- Please set one of the runtime configs: '--memory-limit' or '--mem-pool-type' to see 'top-memory-consumers' result when memory is exhausted.
-
- -d, --disk-limit <DISK_LIMIT>
- Available disk space for spilling queries (e.g. '10g'), default to None (uses DataFusion's default value of '100g')
-
+Usage: datafusion-cli [OPTIONS]
+
+Options:
+ -p, --data-path <DATA_PATH>
+ Path to your data, default to current directory
+ -b, --batch-size <BATCH_SIZE>
+ The batch size of each query, or use DataFusion default
+ -c, --command [<COMMAND>...]
+ Execute the given command string(s), then exit. Commands are expected to be non empty.
+ -m, --memory-limit <MEMORY_LIMIT>
+ The memory pool limitation (e.g. '10g'), default to None (no limit)
+ -f, --file [<FILE>...]
+ Execute commands from file(s), then exit
+ -r, --rc [<RC>...]
+ Run the provided files on startup instead of ~/.datafusionrc
+ --format <FORMAT>
+ [default: automatic] [possible values: csv, tsv, table, json, nd-json, automatic]
+ -q, --quiet
+ Reduce printing other than the results and work quietly
+ --mem-pool-type <MEM_POOL_TYPE>
+ Specify the memory pool type 'greedy' or 'fair' [default: greedy]
+ --top-memory-consumers <TOP_MEMORY_CONSUMERS>
+ The number of top memory consumers to display when query fails due to memory exhaustion. To disable memory consumer tracking, set this value to 0 [default: 3]
+ --maxrows <MAXROWS>
+ The max number of rows to display for 'Table' format
+ [possible values: numbers(0/10/...), inf(no limit)] [default: 40]
+ --color
+ Enables console syntax highlighting
+ -d, --disk-limit <DISK_LIMIT>
+ Available disk space for spilling queries (e.g. '10g'), default to None (uses DataFusion's default value of '100g')
--object-store-profiling <OBJECT_STORE_PROFILING>
Specify the default object_store_profiling mode, defaults to 'disabled'.
[possible values: disabled, summary, trace] [default: Disabled]
-
- -p, --data-path <DATA_PATH>
- Path to your data, default to current directory
-
- -q, --quiet
- Reduce printing other than the results and work quietly
-
- -r, --rc <RC>...
- Run the provided files on startup instead of ~/.datafusionrc
-
- -V, --version
- Print version information
+ -h, --help
+ Print help
+ -V, --version
+ Print version
```
## Commands
diff --git a/searchindex.js b/searchindex.js
index 1b6c3752ae..d6a14b98eb 100644
--- a/searchindex.js
+++ b/searchindex.js
@@ -1 +1 @@
-Search.setIndex({"alltitles":{"!=":[[73,"op-neq"]],"!~":[[73,"op-re-not-match"]],"!~*":[[73,"op-re-not-match-i"]],"!~~":[[73,"id19"]],"!~~*":[[73,"id20"]],"#":[[73,"op-bit-xor"]],"%":[[73,"op-modulo"]],"&":[[73,"op-bit-and"]],"(relation, name) tuples in logical fields and logical columns are unique":[[15,"relation-name-tuples-in-logical-fields-and-logical-columns-are-unique"]],"*":[[73,"op-multiply"]],"+":[[73,"op-plus"]],"-":[[73,"op-minus"]],"/":[[73,"op-divide"]],"1. Array Literal Con [...]
\ No newline at end of file
+Search.setIndex({"alltitles":{"!=":[[73,"op-neq"]],"!~":[[73,"op-re-not-match"]],"!~*":[[73,"op-re-not-match-i"]],"!~~":[[73,"id19"]],"!~~*":[[73,"id20"]],"#":[[73,"op-bit-xor"]],"%":[[73,"op-modulo"]],"&":[[73,"op-bit-and"]],"(relation, name) tuples in logical fields and logical columns are unique":[[15,"relation-name-tuples-in-logical-fields-and-logical-columns-are-unique"]],"*":[[73,"op-multiply"]],"+":[[73,"op-plus"]],"-":[[73,"op-minus"]],"/":[[73,"op-divide"]],"1. Array Literal Con [...]
\ No newline at end of file
diff --git a/user-guide/cli/usage.html b/user-guide/cli/usage.html
index 4ebab35f66..c7e4f27fe7 100644
--- a/user-guide/cli/usage.html
+++ b/user-guide/cli/usage.html
@@ -431,64 +431,45 @@
<section id="usage">
<h1>Usage<a class="headerlink" href="#usage" title="Link to this heading">#</a></h1>
<p>See the current usage using <code class="docutils literal notranslate"><span class="pre">datafusion-cli</span> <span class="pre">--help</span></code>:</p>
-<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>Apache<span class="w"> </span>Arrow<span class="w"> </span><dev@arrow.apache.org>
-Command<span class="w"> </span>Line<span class="w"> </span>Client<span class="w"> </span><span class="k">for</span><span class="w"> </span>DataFusion<span class="w"> </span>query<span class="w"> </span>engine.
-
-USAGE:
-<span class="w"> </span>datafusion-cli<span class="w"> </span><span class="o">[</span>OPTIONS<span class="o">]</span>
-
-OPTIONS:
-<span class="w"> </span>-b,<span class="w"> </span>--batch-size<span class="w"> </span><BATCH_SIZE>
-<span class="w"> </span>The<span class="w"> </span>batch<span class="w"> </span>size<span class="w"> </span>of<span class="w"> </span>each<span class="w"> </span>query,<span class="w"> </span>or<span class="w"> </span>use<span class="w"> </span>DataFusion<span class="w"> </span>default
-
-<span class="w"> </span>-c,<span class="w"> </span>--command<span class="w"> </span><COMMAND>...
-<span class="w"> </span>Execute<span class="w"> </span>the<span class="w"> </span>given<span class="w"> </span><span class="nb">command</span><span class="w"> </span>string<span class="o">(</span>s<span class="o">)</span>,<span class="w"> </span><span class="k">then</span><span class="w"> </span><span class="nb">exit</span>
-
-<span class="w"> </span>--color
-<span class="w"> </span>Enables<span class="w"> </span>console<span class="w"> </span>syntax<span class="w"> </span>highlighting
-
-<span class="w"> </span>-f,<span class="w"> </span>--file<span class="w"> </span><FILE>...
-<span class="w"> </span>Execute<span class="w"> </span>commands<span class="w"> </span>from<span class="w"> </span>file<span class="o">(</span>s<span class="o">)</span>,<span class="w"> </span><span class="k">then</span><span class="w"> </span><span class="nb">exit</span>
-
-<span class="w"> </span>--format<span class="w"> </span><FORMAT>
-<span class="w"> </span><span class="o">[</span>default:<span class="w"> </span>table<span class="o">]</span><span class="w"> </span><span class="o">[</span>possible<span class="w"> </span>values:<span class="w"> </span>csv,<span class="w"> </span>tsv,<span class="w"> </span>table,<span class="w"> </span>json,<span class="w"> </span>nd-json<span class="o">]</span>
-
-<span class="w"> </span>-h,<span class="w"> </span>--help
-<span class="w"> </span>Print<span class="w"> </span><span class="nb">help</span><span class="w"> </span>information
-
-<span class="w"> </span>-m,<span class="w"> </span>--memory-limit<span class="w"> </span><MEMORY_LIMIT>
-<span class="w"> </span>The<span class="w"> </span>memory<span class="w"> </span>pool<span class="w"> </span>limitation<span class="w"> </span><span class="o">(</span>e.g.<span class="w"> </span><span class="s1">'10g'</span><span class="o">)</span>,<span class="w"> </span>default<span class="w"> </span>to<span class="w"> </span>None<span class="w"> </span><span class="o">(</span>no<span class="w"> </span>limit<span class="o">)</span>
-
-<span class="w"> </span>--maxrows<span class="w"> </span><MAXROWS>
-<span class="w"> </span>The<span class="w"> </span>max<span class="w"> </span>number<span class="w"> </span>of<span class="w"> </span>rows<span class="w"> </span>to<span class="w"> </span>display<span class="w"> </span><span class="k">for</span><span class="w"> </span><span class="s1">'Table'</span><span class="w"> </span>format
-<span class="w"> </span><span class="o">[</span>possible<span class="w"> </span>values:<span class="w"> </span>numbers<span class="o">(</span><span class="m">0</span>/10/...<span class="o">)</span>,<span class="w"> </span>inf<span class="o">(</span>no<span class="w"> </span>limit<span class="o">)]</span><span class="w"> </span><span class="o">[</span>default:<span class="w"> </span><span class="m">40</span><span class="o">]</span>
-
-<span class="w"> </span>--mem-pool-type<span class="w"> </span><MEM_POOL_TYPE>
-<span class="w"> </span>Specify<span class="w"> </span>the<span class="w"> </span>memory<span class="w"> </span>pool<span class="w"> </span><span class="nb">type</span><span class="w"> </span><span class="s1">'greedy'</span><span class="w"> </span>or<span class="w"> </span><span class="s1">'fair'</span>,<span class="w"> </span>default<span class="w"> </span>to<span class="w"> </span><span class="s1">'greedy'</span>
-
-<span class="w"> </span>--top-memory-consumers<span class="w"> </span><TOP_MEMORY_CONSUMERS>
-<span class="w"> </span>The<span class="w"> </span>number<span class="w"> </span>of<span class="w"> </span>top<span class="w"> </span>memory<span class="w"> </span>consumers<span class="w"> </span>to<span class="w"> </span>display<span class="w"> </span>when<span class="w"> </span>query<span class="w"> </span>fails<span class="w"> </span>due<span class="w"> </span>to<span class="w"> </span>memory<span class="w"> </span>exhaustion.
-<span class="w"> </span>To<span class="w"> </span>disable<span class="w"> </span>memory<span class="w"> </span>consumer<span class="w"> </span>tracking,<span class="w"> </span><span class="nb">set</span><span class="w"> </span>this<span class="w"> </span>value<span class="w"> </span>to<span class="w"> </span><span class="m">0</span><span class="w"> </span><span class="o">[</span>default:<span class="w"> </span><span class="m">3</span><span class="o">]</span>.
-<span class="w"> </span>Please<span class="w"> </span><span class="nb">set</span><span class="w"> </span>one<span class="w"> </span>of<span class="w"> </span>the<span class="w"> </span>runtime<span class="w"> </span>configs:<span class="w"> </span><span class="s1">'--memory-limit'</span><span class="w"> </span>or<span class="w"> </span><span class="s1">'--mem-pool-type'</span><span class="w"> </span>to<span class="w"> </span>see<span class="w"> </span><span cla [...]
-
-<span class="w"> </span>-d,<span class="w"> </span>--disk-limit<span class="w"> </span><DISK_LIMIT>
-<span class="w"> </span>Available<span class="w"> </span>disk<span class="w"> </span>space<span class="w"> </span><span class="k">for</span><span class="w"> </span>spilling<span class="w"> </span>queries<span class="w"> </span><span class="o">(</span>e.g.<span class="w"> </span><span class="s1">'10g'</span><span class="o">)</span>,<span class="w"> </span>default<span class="w"> </span>to<span class="w"> </span>None<span class="w"> </span><span class="o">(</span>uses<sp [...]
-
+<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>Command<span class="w"> </span>Line<span class="w"> </span>Client<span class="w"> </span><span class="k">for</span><span class="w"> </span>DataFusion<span class="w"> </span>query<span class="w"> </span>engine.
+
+Usage:<span class="w"> </span>datafusion-cli<span class="w"> </span><span class="o">[</span>OPTIONS<span class="o">]</span>
+
+Options:
+<span class="w"> </span>-p,<span class="w"> </span>--data-path<span class="w"> </span><DATA_PATH>
+<span class="w"> </span>Path<span class="w"> </span>to<span class="w"> </span>your<span class="w"> </span>data,<span class="w"> </span>default<span class="w"> </span>to<span class="w"> </span>current<span class="w"> </span>directory
+<span class="w"> </span>-b,<span class="w"> </span>--batch-size<span class="w"> </span><BATCH_SIZE>
+<span class="w"> </span>The<span class="w"> </span>batch<span class="w"> </span>size<span class="w"> </span>of<span class="w"> </span>each<span class="w"> </span>query,<span class="w"> </span>or<span class="w"> </span>use<span class="w"> </span>DataFusion<span class="w"> </span>default
+<span class="w"> </span>-c,<span class="w"> </span>--command<span class="w"> </span><span class="o">[</span><COMMAND>...<span class="o">]</span>
+<span class="w"> </span>Execute<span class="w"> </span>the<span class="w"> </span>given<span class="w"> </span><span class="nb">command</span><span class="w"> </span>string<span class="o">(</span>s<span class="o">)</span>,<span class="w"> </span><span class="k">then</span><span class="w"> </span>exit.<span class="w"> </span>Commands<span class="w"> </span>are<span class="w"> </span>expected<span class="w"> </span>to<span class="w"> </span>be<span class="w"> </span>non<span class [...]
+<span class="w"> </span>-m,<span class="w"> </span>--memory-limit<span class="w"> </span><MEMORY_LIMIT>
+<span class="w"> </span>The<span class="w"> </span>memory<span class="w"> </span>pool<span class="w"> </span>limitation<span class="w"> </span><span class="o">(</span>e.g.<span class="w"> </span><span class="s1">'10g'</span><span class="o">)</span>,<span class="w"> </span>default<span class="w"> </span>to<span class="w"> </span>None<span class="w"> </span><span class="o">(</span>no<span class="w"> </span>limit<span class="o">)</span>
+<span class="w"> </span>-f,<span class="w"> </span>--file<span class="w"> </span><span class="o">[</span><FILE>...<span class="o">]</span>
+<span class="w"> </span>Execute<span class="w"> </span>commands<span class="w"> </span>from<span class="w"> </span>file<span class="o">(</span>s<span class="o">)</span>,<span class="w"> </span><span class="k">then</span><span class="w"> </span><span class="nb">exit</span>
+<span class="w"> </span>-r,<span class="w"> </span>--rc<span class="w"> </span><span class="o">[</span><RC>...<span class="o">]</span>
+<span class="w"> </span>Run<span class="w"> </span>the<span class="w"> </span>provided<span class="w"> </span>files<span class="w"> </span>on<span class="w"> </span>startup<span class="w"> </span>instead<span class="w"> </span>of<span class="w"> </span>~/.datafusionrc
+<span class="w"> </span>--format<span class="w"> </span><FORMAT>
+<span class="w"> </span><span class="o">[</span>default:<span class="w"> </span>automatic<span class="o">]</span><span class="w"> </span><span class="o">[</span>possible<span class="w"> </span>values:<span class="w"> </span>csv,<span class="w"> </span>tsv,<span class="w"> </span>table,<span class="w"> </span>json,<span class="w"> </span>nd-json,<span class="w"> </span>automatic<span class="o">]</span>
+<span class="w"> </span>-q,<span class="w"> </span>--quiet
+<span class="w"> </span>Reduce<span class="w"> </span>printing<span class="w"> </span>other<span class="w"> </span>than<span class="w"> </span>the<span class="w"> </span>results<span class="w"> </span>and<span class="w"> </span>work<span class="w"> </span>quietly
+<span class="w"> </span>--mem-pool-type<span class="w"> </span><MEM_POOL_TYPE>
+<span class="w"> </span>Specify<span class="w"> </span>the<span class="w"> </span>memory<span class="w"> </span>pool<span class="w"> </span><span class="nb">type</span><span class="w"> </span><span class="s1">'greedy'</span><span class="w"> </span>or<span class="w"> </span><span class="s1">'fair'</span><span class="w"> </span><span class="o">[</span>default:<span class="w"> </span>greedy<span class="o">]</span>
+<span class="w"> </span>--top-memory-consumers<span class="w"> </span><TOP_MEMORY_CONSUMERS>
+<span class="w"> </span>The<span class="w"> </span>number<span class="w"> </span>of<span class="w"> </span>top<span class="w"> </span>memory<span class="w"> </span>consumers<span class="w"> </span>to<span class="w"> </span>display<span class="w"> </span>when<span class="w"> </span>query<span class="w"> </span>fails<span class="w"> </span>due<span class="w"> </span>to<span class="w"> </span>memory<span class="w"> </span>exhaustion.<span class="w"> </span>To<span class="w"> </span [...]
+<span class="w"> </span>--maxrows<span class="w"> </span><MAXROWS>
+<span class="w"> </span>The<span class="w"> </span>max<span class="w"> </span>number<span class="w"> </span>of<span class="w"> </span>rows<span class="w"> </span>to<span class="w"> </span>display<span class="w"> </span><span class="k">for</span><span class="w"> </span><span class="s1">'Table'</span><span class="w"> </span>format
+<span class="w"> </span><span class="o">[</span>possible<span class="w"> </span>values:<span class="w"> </span>numbers<span class="o">(</span><span class="m">0</span>/10/...<span class="o">)</span>,<span class="w"> </span>inf<span class="o">(</span>no<span class="w"> </span>limit<span class="o">)]</span><span class="w"> </span><span class="o">[</span>default:<span class="w"> </span><span class="m">40</span><span class="o">]</span>
+<span class="w"> </span>--color
+<span class="w"> </span>Enables<span class="w"> </span>console<span class="w"> </span>syntax<span class="w"> </span>highlighting
+<span class="w"> </span>-d,<span class="w"> </span>--disk-limit<span class="w"> </span><DISK_LIMIT>
+<span class="w"> </span>Available<span class="w"> </span>disk<span class="w"> </span>space<span class="w"> </span><span class="k">for</span><span class="w"> </span>spilling<span class="w"> </span>queries<span class="w"> </span><span class="o">(</span>e.g.<span class="w"> </span><span class="s1">'10g'</span><span class="o">)</span>,<span class="w"> </span>default<span class="w"> </span>to<span class="w"> </span>None<span class="w"> </span><span class="o">(</span>uses<span [...]
<span class="s1"> --object-store-profiling <OBJECT_STORE_PROFILING></span>
<span class="s1"> Specify the default object_store_profiling mode, defaults to '</span>disabled<span class="err">'</span>.
<span class="w"> </span><span class="o">[</span>possible<span class="w"> </span>values:<span class="w"> </span>disabled,<span class="w"> </span>summary,<span class="w"> </span>trace<span class="o">]</span><span class="w"> </span><span class="o">[</span>default:<span class="w"> </span>Disabled<span class="o">]</span>
-
-<span class="w"> </span>-p,<span class="w"> </span>--data-path<span class="w"> </span><DATA_PATH>
-<span class="w"> </span>Path<span class="w"> </span>to<span class="w"> </span>your<span class="w"> </span>data,<span class="w"> </span>default<span class="w"> </span>to<span class="w"> </span>current<span class="w"> </span>directory
-
-<span class="w"> </span>-q,<span class="w"> </span>--quiet
-<span class="w"> </span>Reduce<span class="w"> </span>printing<span class="w"> </span>other<span class="w"> </span>than<span class="w"> </span>the<span class="w"> </span>results<span class="w"> </span>and<span class="w"> </span>work<span class="w"> </span>quietly
-
-<span class="w"> </span>-r,<span class="w"> </span>--rc<span class="w"> </span><RC>...
-<span class="w"> </span>Run<span class="w"> </span>the<span class="w"> </span>provided<span class="w"> </span>files<span class="w"> </span>on<span class="w"> </span>startup<span class="w"> </span>instead<span class="w"> </span>of<span class="w"> </span>~/.datafusionrc
-
-<span class="w"> </span>-V,<span class="w"> </span>--version
-<span class="w"> </span>Print<span class="w"> </span>version<span class="w"> </span>information
+<span class="w"> </span>-h,<span class="w"> </span>--help
+<span class="w"> </span>Print<span class="w"> </span><span class="nb">help</span>
+<span class="w"> </span>-V,<span class="w"> </span>--version
+<span class="w"> </span>Print<span class="w"> </span>version
</pre></div>
</div>
<section id="commands">
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@datafusion.apache.org
For additional commands, e-mail: commits-help@datafusion.apache.org