feat: Ballista Text User Interface

ballista-cli/Cargo.toml

@@ -30,14 +30,29 @@ readme = "README.md"
 
 [dependencies]
 ballista = { path = "../ballista/client", version = "53.0.0", features = ["standalone"] }
+chrono = { version = "0.4", default-features = false, features = ["std", "clock"], optional = true }
 clap = { workspace = true, features = ["derive", "cargo"] }
+config = { version = "0.15.19", default-features = false, features = ["yaml"], optional = true }
+crossterm = { version = "0.29.0", features = ["event-stream"], optional = true }
 datafusion = { workspace = true }
 datafusion-cli = { workspace = true }
 dirs = "6.0"
+dotparser = { version = "0.3.0", optional = true }
 env_logger = { workspace = true }
+futures = { version = "0.3.31", optional = true }
 mimalloc = { workspace = true }
+percent-encoding = { version = "2.3.2", optional = true }
+prometheus-parse = { version = "0.2", optional = true }
+ratatui = { version = "0.30.0", optional = true }
+reqwest = { version = "0.13.1", features = ["json"], optional = true }
 rustyline = "17.0.1"
-tokio = { workspace = true, features = ["macros", "rt", "rt-multi-thread", "sync", "parking_lot"] }
+serde = { version = "1", features = ["derive"], optional = true }
+serde_json = { version = "1", optional = true }
+tokio = { workspace = true, features = ["macros", "rt", "rt-multi-thread", "sync", "time", "parking_lot"] }
+tracing = { version = "0.1", optional = true }
+tracing-appender = { version = "0.2", optional = true }
+tracing-subscriber = { version = "0.3", features = ["env-filter", "fmt"], optional = true }
+tui-big-text = { version = "0.8.2", optional = true }
 
 [features]
-
+tui = ["dep:chrono", "dep:config", "dep:crossterm", "dep:dotparser", "dep:futures", "dep:percent-encoding", "dep:prometheus-parse", "dep:ratatui", "dep:reqwest", "dep:serde", "dep:serde_json", "dep:tracing", "dep:tracing-subscriber", "dep:tracing-appender", "dep:tui-big-text"]

ballista-cli/src/command.rs

@@ -43,6 +43,8 @@ pub enum Command {
     SearchFunctions(String),
     QuietMode(Option<bool>),
     OutputFormat(Option<String>),
+    #[cfg(feature = "tui")]
+    OpenTui,
 }
 
 pub enum OutputFormat {
@@ -129,11 +131,18 @@ impl Command {
                 "Unexpected change output format, this should be handled outside"
                     .to_string(),
             )),
+            #[cfg(feature = "tui")]
+            Self::OpenTui => match crate::tui::tui_main().await {
+                Ok(()) => Ok(()),
+                Err(e) => Err(DataFusionError::Internal(format!(
+                    "Error opening TUI: {e}",
+                ))),
+            },
         }
     }
 
     fn get_name_and_description(&self) -> (&'static str, &'static str) {
-        match self {
+        match *self {
             Self::Quit => ("\\q", "quit ballista-cli"),
             Self::ListTables => ("\\d", "list tables"),
             Self::DescribeTable(_) => ("\\d name", "describe table"),
@@ -144,11 +153,13 @@ impl Command {
             Self::OutputFormat(_) => {
                 ("\\pset [NAME [VALUE]]", "set table output option\n(format)")
             }
+            #[cfg(feature = "tui")]
+            Self::OpenTui => ("\\tui", "open tui"),
         }
     }
 }
 
-const ALL_COMMANDS: [Command; 8] = [
+const ALL_COMMANDS: &[Command] = &[
     Command::ListTables,
     Command::DescribeTable(String::new()),
     Command::Quit,
@@ -157,6 +168,8 @@ const ALL_COMMANDS: [Command; 8] = [
     Command::SearchFunctions(String::new()),
     Command::QuietMode(None),
     Command::OutputFormat(None),
+    #[cfg(feature = "tui")]
+    Command::OpenTui,
 ];
 
 fn all_commands_info() -> RecordBatch {
@@ -165,7 +178,7 @@ fn all_commands_info() -> RecordBatch {
         Field::new("Description", DataType::Utf8, false),
     ]));
     let (names, description): (Vec<&str>, Vec<&str>) = ALL_COMMANDS
-        .into_iter()
+        .iter()
         .map(|c| c.get_name_and_description())
         .unzip();
     RecordBatch::try_new(
@@ -205,6 +218,8 @@ impl FromStr for Command {
                 Self::OutputFormat(Some(subcommand.to_string()))
             }
             ("pset", None) => Self::OutputFormat(None),
+            #[cfg(feature = "tui")]
+            ("tui", None) => Self::OpenTui,
             _ => return Err(()),
         })
     }

ballista-cli/src/lib.rs

@@ -20,5 +20,7 @@ pub const BALLISTA_CLI_VERSION: &str = env!("CARGO_PKG_VERSION");
 
 pub mod command;
 pub mod exec;
+#[cfg(feature = "tui")]
+mod tui;
 
 pub use datafusion_cli::{functions, helper, print_format, print_options};

ballista-cli/src/main.rs

@@ -15,6 +15,9 @@
 // specific language governing permissions and limitations
 // under the License.
 
+#[cfg(feature = "tui")]
+mod tui;
+
 use std::path::Path;
 use std::{env, sync::Arc};
 
@@ -24,7 +27,6 @@ use ballista_cli::{
 };
 use clap::Parser;
 use datafusion::{
-    common::Result,
     execution::SessionStateBuilder,
     prelude::{SessionConfig, SessionContext},
 };
@@ -99,20 +101,31 @@ struct Args {
 
     #[clap(long, help = "Enables console syntax highlighting")]
     color: bool,
+
+    #[cfg(feature = "tui")]
+    #[clap(long, help = "Enables terminal user interface")]
+    tui: bool,
 }
 
 #[tokio::main]
-pub async fn main() -> Result<()> {
-    env_logger::init();
+pub async fn main() -> Result<(), Box<dyn std::error::Error>> {
     let args = Args::parse();
 
+    #[cfg(feature = "tui")]
+    if args.tui {
+        return tui::tui_main()
+            .await
+            .map_err(|e| Box::new(e) as Box<dyn std::error::Error>);
+    }
+    env_logger::init();
+
     if !args.quiet {
         println!("Ballista CLI v{BALLISTA_CLI_VERSION}");
     }
 
     if let Some(ref path) = args.data_path {
         let p = Path::new(path);
-        env::set_current_dir(p).unwrap();
+        env::set_current_dir(p)?;
     };
 
     let mut ballista_config =