ballista-cli 55.0.0

Command Line Client for Ballista distributed query engine.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91

<!---
  Licensed to the Apache Software Foundation (ASF) under one
  or more contributor license agreements.  See the NOTICE file
  distributed with this work for additional information
  regarding copyright ownership.  The ASF licenses this file
  to you under the Apache License, Version 2.0 (the
  "License"); you may not use this file except in compliance
  with the License.  You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

  Unless required by applicable law or agreed to in writing,
  software distributed under the License is distributed on an
  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
  KIND, either express or implied.  See the License for the
  specific language governing permissions and limitations
  under the License.
-->

# Ballista Command-line Interface

[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.

```ignore
Command Line Client for Ballista distributed query engine.

Usage: ballista-cli [OPTIONS]

Options:
  -p, --data-path <DATA_PATH>    Path to your data, default to current directory
  -c, --batch-size <BATCH_SIZE>  The batch size of each query, or use Ballista default
      --vcores <VCORES>          Virtual cores for the local Ballista executor. Default: all available physical cores.
  -f, --file [<FILE>...]         Execute commands from file(s), then exit
  -r, --rc [<RC>...]             Run the provided files on startup instead of ~/.ballistarc
      --format <FORMAT>          [default: table] [possible values: csv, tsv, table, json, nd-json, automatic]
      --host <HOST>              Ballista scheduler host
      --port <PORT>              Ballista scheduler port
  -q, --quiet                    Reduce printing other than the results and work quietly
      --color                    Enables console syntax highlighting
      --tui                      Enables terminal user interface
  -h, --help                     Print help
  -V, --version                  Print version
```

## Example

Create a CSV file to query.

```bash,ignore
$ echo "1,2" > data.csv
```

```sql,ignore
$ ballista-cli

Ballista CLI v54.0.0

> CREATE EXTERNAL TABLE foo (a INT, b INT) STORED AS CSV LOCATION 'data.csv';
0 rows in set. Query took 0.001 seconds.

> SELECT * FROM foo;
+---+---+
| a | b |
+---+---+
| 1 | 2 |
+---+---+
1 row in set. Query took 0.017 seconds.

> \q
```

## Ballista-Cli

If you want to execute the SQL in ballista by `ballista-cli`, you must build/compile `ballista-cli` first.

```bash
cd datafusion-ballista/ballista-cli
cargo build
cargo install --path .
```

The Ballista CLI can connect to a Ballista scheduler for query execution.

```bash
ballista-cli --host localhost --port 50050
```

[ballista]: https://crates.io/crates/ballista