You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@arrow.apache.org by nj...@apache.org on 2023/06/28 01:28:17 UTC
[arrow-ballista] branch main updated: Fix ballista-cli docs (#800)
This is an automated email from the ASF dual-hosted git repository.
nju_yaho pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/arrow-ballista.git
The following commit(s) were added to refs/heads/main by this push:
new ba33af16 Fix ballista-cli docs (#800)
ba33af16 is described below
commit ba33af1633b1b8dc77c88d1bd2f858ada992ce01
Author: Jonah Gao <jo...@gmail.com>
AuthorDate: Wed Jun 28 09:28:11 2023 +0800
Fix ballista-cli docs (#800)
---
ballista-cli/README.md | 6 +++---
docs/source/user-guide/cli.md | 6 +++---
2 files changed, 6 insertions(+), 6 deletions(-)
diff --git a/ballista-cli/README.md b/ballista-cli/README.md
index b5314c80..e35c1ac0 100644
--- a/ballista-cli/README.md
+++ b/ballista-cli/README.md
@@ -19,7 +19,7 @@
# Ballista Command-line Interface
-[Ballista](df) is a distributed query execution framework, written in Rust, that uses Apache Arrow as its in-memory format.
+[Ballista][ballista] is a distributed query execution framework, written in Rust, that uses Apache Arrow as its in-memory format.
The Ballista CLI allows SQL queries to be executed by an in-process DataFusion context, or by a distributed
Ballista context.
@@ -72,7 +72,7 @@ Ballista CLI v0.6.0
If you want to execute the SQL in ballista by `ballista-cli`, you must build/compile `ballista-cli` first.
```bash
-cd arrow-datafusion/ballista-cli
+cd arrow-ballista/ballista-cli
cargo build
```
@@ -82,4 +82,4 @@ The Ballista CLI can connect to a Ballista scheduler for query execution.
ballista-cli --host localhost --port 50050
```
-[df]: https://crates.io/crates/datafusion
+[ballista]: https://crates.io/crates/ballista
diff --git a/docs/source/user-guide/cli.md b/docs/source/user-guide/cli.md
index ad238320..213f6034 100644
--- a/docs/source/user-guide/cli.md
+++ b/docs/source/user-guide/cli.md
@@ -35,7 +35,7 @@ USAGE:
ballista-cli [OPTIONS]
OPTIONS:
- -c, --batch-size <BATCH_SIZE> The batch size of each query, or use DataFusion default
+ -c, --batch-size <BATCH_SIZE> The batch size of each query, or use Ballista default
-f, --file <FILE>... Execute commands from file(s), then exit
--format <FORMAT> [default: table] [possible values: csv, tsv, table, json,
nd-json]
@@ -44,7 +44,7 @@ OPTIONS:
-p, --data-path <DATA_PATH> Path to your data, default to current directory
--port <PORT> Ballista scheduler port
-q, --quiet Reduce printing other than the results and work quietly
- -r, --rc <RC>... Run the provided files on startup instead of ~/.datafusionrc
+ -r, --rc <RC>... Run the provided files on startup instead of ~/.ballistarc
-V, --version Print version information
```
@@ -61,7 +61,7 @@ $ echo "1,2" > data.csv
The CLI can connect to a Ballista scheduler for query execution.
```bash
-datafusion-cli --host localhost --port 50050
+ballista-cli --host localhost --port 50050
```
## Run Ballista CLI in Standalone Mode