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 443af7d651 Publish built docs triggered by
963680dd23f952c55ebf8ff973f8d8fa7d0070a1
443af7d651 is described below
commit 443af7d651290b30714f005f6db659efb91a4841
Author: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
AuthorDate: Fri Sep 22 12:31:22 2023 +0000
Publish built docs triggered by 963680dd23f952c55ebf8ff973f8d8fa7d0070a1
---
_sources/user-guide/cli.md.txt | 47 ++++++++++++++++++++++++++++++++----------
searchindex.js | 2 +-
user-guide/cli.html | 47 ++++++++++++++++++++++++++++++++----------
3 files changed, 73 insertions(+), 23 deletions(-)
diff --git a/_sources/user-guide/cli.md.txt b/_sources/user-guide/cli.md.txt
index e1f332baf3..05b4165e61 100644
--- a/_sources/user-guide/cli.md.txt
+++ b/_sources/user-guide/cli.md.txt
@@ -75,17 +75,42 @@ USAGE:
datafusion-cli [OPTIONS]
OPTIONS:
- -c, --batch-size <BATCH_SIZE> The batch size of each query, or
use DataFusion default
- -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)
- --mem-pool-type <MEM_POOL_TYPE> Specify the memory pool type
'greedy' or 'fair', default to 'greedy'
- -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
+ -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
+
+ -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
+ [default: 40] [possible values: numbers(0/10/...), inf(no limit)]
+
+ --mem-pool-type <MEM_POOL_TYPE>
+ Specify the memory pool type 'greedy' or 'fair', default to
'greedy'
+
+ -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
```
## Querying data from the files directly
diff --git a/searchindex.js b/searchindex.js
index d829a8e584..142b5ff1ce 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 857acb8420..035f146c77 100644
--- a/user-guide/cli.html
+++ b/user-guide/cli.html
@@ -522,17 +522,42 @@ 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>-c,<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>-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 cl [...]
-<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 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>-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>-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>default:<span
class="w"> </span><span class="m">40</span><span class="o">]</span><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>--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>-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
</pre></div>
</div>
</section>
