version: "1.0.1" name: arrow-cli description: Use arrow_cli to connect to a Flight SQL server and run SQL.

arrow_cli

arrow_cli is a command-line client for connecting to a Flight SQL server and executing SQL queries.

Install

cargo install arrow_cli

After installation, confirm that the binary is available:

arrow_cli --version

Usage

Execute one SQL statement and exit

arrow_cli --host localhost --port 8900 --user admin --password abc --command "select 1"

Output:

+----------+
| Int64(1) |
+----------+
| 1        |
+----------+
 
1 rows in set (tickets received in 0.008 sec, rows received in 0.012 sec)

Execute SQL from a file and exit

arrow_cli --host localhost --port 8900 --user admin --password abc --file query.sql

The file content is read as a single SQL statement and executed once, then the CLI exits.

Pipe SQL through standard input

echo "select 1" | arrow_cli --host localhost --port 8900 --user admin --password abc

Option: print the result schema

arrow_cli --host localhost --port 8900 --user admin --password abc --print-schema --command "select 1"

Output:

+----------+
| Int64(1) |
+----------+
| 1        |
+----------+
 
Schema {
    fields: [
        Field {
            name: "Int64(1)",
            data_type: Int64,
        },
    ],
    metadata: {},
}
 
1 rows in set (tickets received in 0.008 sec, rows received in 0.010 sec)

Option: output formats

• --output table: pretty table output with row count and timing summary
• --output json: line-delimited JSON rows
• --output csv: comma-separated rows without headers
• --output tsv: tab-separated rows without headers
• --output psv: pipe-separated rows without headers

Run arrow_cli --help for more usage details.