DataFusion Command-line Interface¶
The DataFusion CLI allows SQL queries to be executed by an in-process DataFusion context, or by a distributed Ballista context.
USAGE:
datafusion-cli [FLAGS] [OPTIONS]
FLAGS:
-h, --help Prints help information
-q, --quiet Reduce printing other than the results and work quietly
-V, --version Prints version information
OPTIONS:
-c, --batch-size <batch-size> The batch size of each query, or use DataFusion default
-p, --data-path <data-path> Path to your data, default to current directory
-f, --file <file>... Execute commands from file(s), then exit
--format <format> Output format [default: table] [possible values: csv, tsv, table, json, ndjson]
--host <host> Ballista scheduler host
--port <port> Ballista scheduler port
Example¶
Create a CSV file to query.
$ echo "1,2" > data.csv
$ datafusion-cli
DataFusion CLI v5.1.0-SNAPSHOT
> 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.
Ballista¶
The DataFusion CLI can also connect to a Ballista scheduler for query execution.
datafusion-cli --host localhost --port 50050
Cli commands¶
Available commands inside DataFusion CLI are:
Quit
> \q
Help
> \?
ListTables
> \d
DescribeTable
> \d table_name
QuietMode
> \quiet [true|false]
list function
> \h
Search and describe function
> \h function_table