feat: add non-interactive usage modes

Author: esadek

Cargo.lock

@@ -16,3 +16,6 @@ nu-ansi-term = "0.50.3"
 reedline = "0.45.0"
 syntect = "5.3.0"
 terminal-colorsaurus = "1.0.3"
+
+[dev-dependencies]
+tempfile = "3.14.0"

Cargo.toml

@@ -31,17 +31,19 @@ The binary will be built to `./target/release/adbcli`.
 
 Install the DuckDB ADBC driver with [dbc](https://docs.columnar.tech/dbc/):
 
-```sh
-dbc install duckdb
+```console
+$ dbc install duckdb
 ```
 
+### Interactive Usage
+
 Connect to DuckDB (in-memory):
 
-```sh
-adbcli --driver duckdb
+```console
+$ adbcli --driver duckdb
 ```
 
-Run SQL queries:
+Execute SQL queries:
 
 ```
 〉CREATE TABLE penguins AS FROM 'https://blobs.duckdb.org/data/penguins.csv';
@@ -62,6 +64,41 @@ Run SQL queries:
 └─────────┴───────────┴────────────────┴───────────────┴───────────────────┴─────────────┴────────┴──────┘
 ```
 
+### Non-interactive Usage
+
+Execute a query directly and exit:
+
+```console
+$ adbcli --driver duckdb --query "SELECT 2 AS favorite_num"
+┌──────────────┐
+│ favorite_num │
+╞══════════════╡
+│ 2            │
+└──────────────┘
+```
+
+Execute a query from a file and exit:
+
+```console
+$ adbcli --driver duckdb --file select_example.sql
+┌────────────┐
+│ the_answer │
+╞════════════╡
+│ 42         │
+└────────────┘
+```
+
+Execute a query from stdin and exit:
+
+```console
+$ echo "SELECT 'Emil' AS name" | adbcli --driver duckdb
+┌──────┐
+│ name │
+╞══════╡
+│ Emil │
+└──────┘
+```
+
 ## Reference
 
 ```console
@@ -76,6 +113,8 @@ Options:
       --username <username>  Database user username
       --password <password>  Database user password
       --option <option>      Driver-specific database option
+      --query <query>        Execute query and exit
+      --file <file>          Read and execute file and exit
   -h, --help                 Print help
   -V, --version              Print version
 ```

README.md

@@ -18,17 +18,19 @@ A command-line tool for querying databases via [ADBC](https://arrow.apache.org/a
 
 Install the DuckDB ADBC driver with [dbc](https://docs.columnar.tech/dbc/):
 
-```sh
-dbc install duckdb
+```console
+$ dbc install duckdb
 ```
 
+### Interactive Usage
+
 Connect to DuckDB (in-memory):
 
-```sh
-adbcli --driver duckdb
+```console
+$ adbcli --driver duckdb
 ```
 
-Run SQL queries:
+Execute SQL queries:
 
 ```
 〉CREATE TABLE penguins AS FROM 'https://blobs.duckdb.org/data/penguins.csv';
@@ -48,3 +50,38 @@ Run SQL queries:
 │ Adelie  │ Torgersen │ 36.7           │ 19.3          │ 193               │ 3450        │ female │ 2007 │
 └─────────┴───────────┴────────────────┴───────────────┴───────────────────┴─────────────┴────────┴──────┘
 ```
+
+### Non-interactive Usage
+
+Execute a query directly and exit:
+
+```console
+$ adbcli --driver duckdb --query "SELECT 2 AS favorite_num"
+┌──────────────┐
+│ favorite_num │
+╞══════════════╡
+│ 2            │
+└──────────────┘
+```
+
+Execute a query from a file and exit:
+
+```console
+$ adbcli --driver duckdb --file select_example.sql
+┌────────────┐
+│ the_answer │
+╞════════════╡
+│ 42         │
+└────────────┘
+```
+
+Execute a query from stdin and exit:
+
+```console
+$ echo "SELECT 'Emil' AS name" | adbcli --driver duckdb
+┌──────┐
+│ name │
+╞══════╡
+│ Emil │
+└──────┘
+```

docs/index.md

@@ -44,6 +44,22 @@ Driver-specific database option
 adbcli --driver duckdb --option path=file.db
 ```
 
+## --query
+
+Execute query and exit
+
+```sh
+adbcli --driver duckdb --query "SELECT 42 AS the_answer"
+```
+
+## --file
+
+Read and execute file and exit
+
+```sh
+adbcli --driver duckdb --file select_example.sql
+```
+
 ## --help
 
 Print the help message

docs/reference.md

@@ -1,12 +1,27 @@
 use clap::{Arg, ArgAction, Command};
+use std::path::PathBuf;
 use std::process::exit;
 
+#[derive(Debug, Clone)]
+pub enum QuerySource {
+    Query(String),
+    File(PathBuf),
+    Stdin,
+    Interactive,
+}
+
 pub struct DatabaseConfig {
     pub driver_name: String,
     pub uri: Option<String>,
     pub username: Option<String>,
     pub password: Option<String>,
     pub options: Vec<(String, String)>,
+    pub query_source: QuerySource,
+}
+
+fn is_stdin_piped() -> bool {
+    use std::io::IsTerminal;
+    !std::io::stdin().is_terminal()
 }
 
 pub fn parse_args() -> DatabaseConfig {
@@ -28,6 +43,14 @@ pub fn parse_args() -> DatabaseConfig {
             .long("option")
             .help("Driver-specific database option")
             .action(ArgAction::Append),
+        Arg::new("query")
+            .long("query")
+            .help("Execute query and exit")
+            .conflicts_with("file"),
+        Arg::new("file")
+            .long("file")
+            .help("Read and execute file and exit")
+            .conflicts_with("query"),
     ];
     let command = Command::new("adbcli")
         .version(env!("CARGO_PKG_VERSION"))
@@ -61,12 +84,23 @@ pub fn parse_args() -> DatabaseConfig {
         }
     }
 
+    let query_source = if let Some(query) = matches.get_one::<String>("query") {
+        QuerySource::Query(query.clone())
+    } else if let Some(file) = matches.get_one::<String>("file") {
+        QuerySource::File(PathBuf::from(file))
+    } else if is_stdin_piped() {
+        QuerySource::Stdin
+    } else {
+        QuerySource::Interactive
+    };
+
     DatabaseConfig {
         driver_name,
         uri,
         username,
         password,
         options,
+        query_source,
     }
 }
 
@@ -128,6 +162,7 @@ mod tests {
             username: Some("test_user".to_string()),
             password: Some("test_pass".to_string()),
             options: vec![("key1".to_string(), "val1".to_string())],
+            query_source: QuerySource::Interactive,
         };
 
         assert_eq!(config.driver_name, "test_driver");
@@ -146,6 +181,7 @@ mod tests {
             username: None,
             password: None,
             options: vec![],
+            query_source: QuerySource::Interactive,
         };
 
         assert_eq!(config.driver_name, "test_driver");

src/cli.rs

@@ -1,6 +1,7 @@
 use crate::cli::DatabaseConfig;
+use crate::table;
 use adbc_core::options::{AdbcVersion, OptionDatabase, OptionValue};
-use adbc_core::{Connection, Database, Driver, LOAD_FLAG_DEFAULT};
+use adbc_core::{Connection, Database, Driver, LOAD_FLAG_DEFAULT, Statement};
 use adbc_driver_manager::ManagedDriver;
 use std::process::exit;
 
@@ -53,3 +54,27 @@ pub fn initialize_connection(config: DatabaseConfig) -> impl Connection {
         }
     }
 }
+
+pub fn execute_query(connection: &mut impl adbc_core::Connection, sql: &str) -> Result<(), String> {
+    if sql.trim().is_empty() {
+        return Ok(());
+    }
+
+    let mut statement = connection
+        .new_statement()
+        .map_err(|e| format!("Failed to create statement: {e}"))?;
+
+    statement
+        .set_sql_query(sql)
+        .map_err(|e| format!("Failed to set SQL query: {e}"))?;
+
+    let reader = statement
+        .execute()
+        .map_err(|e| format!("Failed to execute statement: {e}"))?;
+
+    let batches: Vec<arrow_array::RecordBatch> = reader
+        .collect::<Result<_, _>>()
+        .map_err(|e| format!("Failed to collect batches: {e}"))?;
+
+    table::print_batches(&batches).map_err(|e| format!("Failed to print batches: {e}"))
+}

src/database.rs

@@ -4,8 +4,51 @@ mod highlighter;
 mod repl;
 mod table;
 
+use cli::{QuerySource, parse_args};
+use std::io::Read;
+use std::process::exit;
+
 fn main() {
-    let config = cli::parse_args();
-    let connection = database::initialize_connection(config);
-    repl::run_repl(connection);
+    let config = parse_args();
+    let query_source = config.query_source.clone();
+
+    match query_source {
+        QuerySource::Query(sql) => {
+            let mut connection = database::initialize_connection(config);
+            if let Err(e) = database::execute_query(&mut connection, &sql) {
+                eprintln!("{e}");
+                exit(1);
+            }
+        }
+        QuerySource::File(path) => {
+            let sql = match std::fs::read_to_string(&path) {
+                Ok(content) => content,
+                Err(e) => {
+                    eprintln!("Failed to read file {}: {e}", path.display());
+                    exit(1);
+                }
+            };
+            let mut connection = database::initialize_connection(config);
+            if let Err(e) = database::execute_query(&mut connection, &sql) {
+                eprintln!("{e}");
+                exit(1);
+            }
+        }
+        QuerySource::Stdin => {
+            let mut sql = String::new();
+            if let Err(e) = std::io::stdin().read_to_string(&mut sql) {
+                eprintln!("Failed to read from stdin: {e}");
+                exit(1);
+            }
+            let mut connection = database::initialize_connection(config);
+            if let Err(e) = database::execute_query(&mut connection, &sql) {
+                eprintln!("{e}");
+                exit(1);
+            }
+        }
+        QuerySource::Interactive => {
+            let connection = database::initialize_connection(config);
+            repl::run_repl(connection);
+        }
+    }
 }