Update CLI examples

kamu-data · Dec 30, 2024 · acb7458 · acb7458
1 parent 6da3120
commit acb7458
Show file tree

Hide file tree

Showing 2 changed files with 41 additions and 3 deletions.
diff --git a/resources/cli-reference.md b/resources/cli-reference.md
@@ -1080,7 +1080,7 @@ Executes an SQL query or drops you into an SQL shell
 
 **Subcommands:**
 
-* `server` — Run SQL server
+* `server` — Runs an SQL engine in a server mode
 
 **Options:**
 
@@ -1149,7 +1149,7 @@ Note: Currently when connecting to a remote SQL kamu server you will need to man
 
 ## `kamu sql server`
 
-Run SQL server
+Runs an SQL engine in a server mode
 
 **Usage:** `kamu sql server [OPTIONS]`
 
@@ -1163,6 +1163,25 @@ Run SQL server
 
 * `--livy` — Run Livy server instead of JDBC
 
+**Examples:**
+
+By default runs the DataFusion engine exposing the FlightSQL protocol:
+
+    kamu sql server
+
+To customize interface and port:
+
+    kamu sql server --address 0.0.0.0 --port 50050
+
+To run with Spark engine:
+
+    kamu sql server --engine spark
+
+By default Spark runs with JDBC protocol, to instead run with Livy HTTP gateway:
+
+    kamu sql server --engine spark --livy
+
+
 
 
 ## `kamu system`

diff --git a/src/app/cli/src/cli.rs b/src/app/cli/src/cli.rs
@@ -1291,8 +1291,27 @@ pub enum SqlSubCommand {
     Server(SqlServer),
 }
 
-/// Run SQL server
+/// Runs an SQL engine in a server mode
 #[derive(Debug, clap::Args)]
+#[command(after_help = r#"
+**Examples:**
+
+By default runs the DataFusion engine exposing the FlightSQL protocol:
+
+    kamu sql server
+
+To customize interface and port:
+
+    kamu sql server --address 0.0.0.0 --port 50050
+
+To run with Spark engine:
+
+    kamu sql server --engine spark
+
+By default Spark runs with JDBC protocol, to instead run with Livy HTTP gateway:
+
+    kamu sql server --engine spark --livy
+"#)]
 pub struct SqlServer {
     /// Expose server on specific network interface
     #[arg(long)]