mirrors/limbo
1
0
Fork 0
mirror of https://github.com/tursodatabase/limbo.git synced 2025-07-07 20:45:01 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 10

cli: Add support for .headers command

Browse source 
The `.headers` command takes `on` and `off` as parameter, supported by
SQLite, which controls whether result set header is printed in list mode.
This commit is contained in:
Pekka Enberg 2025-07-07 13:19:27 +03:00
parent 99a23330a5
commit 42c08b5bea
4 changed files with 103 additions and 50 deletions
Download patch file Download diff file Expand all files Collapse all files

121
cli/app.rs
View file

@ -1,6 +1,6 @@
use crate::{ use crate::{
commands::{ commands::{
args::{EchoMode, TimerMode}, args::{EchoMode, HeadersMode, TimerMode},
import::ImportFile, import::ImportFile,
Command, CommandParser, Command, CommandParser,
}, },
@ -676,6 +676,12 @@ impl Limbo {
TimerMode::Off => false, TimerMode::Off => false,
}; };
} }
Command::Headers(headers_mode) => {
self.opts.headers = match headers_mode.mode {
HeadersMode::On => true,
HeadersMode::Off => false,
};
}
}, },
} }
} }
@ -688,62 +694,83 @@ impl Limbo {
) -> anyhow::Result<()> { ) -> anyhow::Result<()> {
match output { match output {
Ok(Some(ref mut rows)) => match self.opts.output_mode { Ok(Some(ref mut rows)) => match self.opts.output_mode {
OutputMode::List => loop { OutputMode::List => {
if self.interrupt_count.load(Ordering::SeqCst) > 0 { let mut headers_printed = false;
println!("Query interrupted."); loop {
return Ok(()); if self.interrupt_count.load(Ordering::SeqCst) > 0 {
} println!("Query interrupted.");
return Ok(());
}
let start = Instant::now(); let start = Instant::now();
match rows.step() { match rows.step() {
Ok(StepResult::Row) => { Ok(StepResult::Row) => {
if let Some(ref mut stats) = statistics { if let Some(ref mut stats) = statistics {
stats.execute_time_elapsed_samples.push(start.elapsed()); stats.execute_time_elapsed_samples.push(start.elapsed());
}
let row = rows.row().unwrap();
for (i, value) in row.get_values().enumerate() {
if i > 0 {
let _ = self.writer.write(b"|");
} }
if matches!(value, Value::Null) {
let _ = self.writer.write(self.opts.null_value.as_bytes())?; // Print headers if enabled and not already printed
} else { if self.opts.headers && !headers_printed {
let _ = self.writer.write(format!("{}", value).as_bytes())?; for i in 0..rows.num_columns() {
if i > 0 {
let _ = self.writer.write(b"|");
}
let _ =
self.writer.write(rows.get_column_name(i).as_bytes());
}
let _ = self.writeln("");
headers_printed = true;
}
let row = rows.row().unwrap();
for (i, value) in row.get_values().enumerate() {
if i > 0 {
let _ = self.writer.write(b"|");
}
if matches!(value, Value::Null) {
let _ =
self.writer.write(self.opts.null_value.as_bytes())?;
} else {
let _ =
self.writer.write(format!("{}", value).as_bytes())?;
}
}
let _ = self.writeln("");
}
Ok(StepResult::IO) => {
let start = Instant::now();
self.io.run_once()?;
if let Some(ref mut stats) = statistics {
stats.io_time_elapsed_samples.push(start.elapsed());
} }
} }
let _ = self.writeln(""); Ok(StepResult::Interrupt) => break,
} Ok(StepResult::Done) => {
Ok(StepResult::IO) => { if let Some(ref mut stats) = statistics {
let start = Instant::now(); stats.execute_time_elapsed_samples.push(start.elapsed());
self.io.run_once()?; }
if let Some(ref mut stats) = statistics { break;
stats.io_time_elapsed_samples.push(start.elapsed());
} }
} Ok(StepResult::Busy) => {
Ok(StepResult::Interrupt) => break, if let Some(ref mut stats) = statistics {
Ok(StepResult::Done) => { stats.execute_time_elapsed_samples.push(start.elapsed());
if let Some(ref mut stats) = statistics { }
stats.execute_time_elapsed_samples.push(start.elapsed()); let _ = self.writeln("database is busy");
break;
} }
break; Err(err) => {
} if let Some(ref mut stats) = statistics {
Ok(StepResult::Busy) => { stats.execute_time_elapsed_samples.push(start.elapsed());
if let Some(ref mut stats) = statistics { }
stats.execute_time_elapsed_samples.push(start.elapsed()); let report =
miette::Error::from(err).with_source_code(sql.to_owned());
let _ = self.write_fmt(format_args!("{:?}", report));
break;
} }
let _ = self.writeln("database is busy");
break;
}
Err(err) => {
if let Some(ref mut stats) = statistics {
stats.execute_time_elapsed_samples.push(start.elapsed());
}
let _ = self.writeln(err.to_string());
break;
} }
} }
}, }
OutputMode::Pretty => { OutputMode::Pretty => {
if self.interrupt_count.load(Ordering::SeqCst) > 0 { if self.interrupt_count.load(Ordering::SeqCst) > 0 {
println!("Query interrupted."); println!("Query interrupted.");

11
cli/commands/args.rs
View file

@ -124,3 +124,14 @@ pub struct TimerArgs {
#[arg(value_enum)] #[arg(value_enum)]
pub mode: TimerMode, pub mode: TimerMode,
} }
#[derive(Debug, Clone, Args)]
pub struct HeadersArgs {
pub mode: HeadersMode,
}
#[derive(ValueEnum, Copy, Clone, Debug, PartialEq, Eq)]
pub enum HeadersMode {
On,
Off,
}

7
cli/commands/mod.rs
View file

@ -2,8 +2,8 @@ pub mod args;
pub mod import; pub mod import;
use args::{ use args::{
CwdArgs, EchoArgs, ExitArgs, IndexesArgs, LoadExtensionArgs, NullValueArgs, OpcodesArgs, CwdArgs, EchoArgs, ExitArgs, HeadersArgs, IndexesArgs, LoadExtensionArgs, NullValueArgs,
OpenArgs, OutputModeArgs, SchemaArgs, SetOutputArgs, TablesArgs, TimerArgs, OpcodesArgs, OpenArgs, OutputModeArgs, SchemaArgs, SetOutputArgs, TablesArgs, TimerArgs,
}; };
use clap::Parser; use clap::Parser;
use import::ImportArgs; use import::ImportArgs;
@ -77,6 +77,9 @@ pub enum Command {
ListIndexes(IndexesArgs), ListIndexes(IndexesArgs),
#[command(name = "timer", display_name = ".timer")] #[command(name = "timer", display_name = ".timer")]
Timer(TimerArgs), Timer(TimerArgs),
/// Toggle column headers on/off in list mode
#[command(name = "headers", display_name = ".headers")]
Headers(HeadersArgs),
} }
const _HELP_TEMPLATE: &str = "{before-help}{name} const _HELP_TEMPLATE: &str = "{before-help}{name}

14
cli/input.rs
View file

@ -83,6 +83,7 @@ pub struct Settings {
pub io: Io, pub io: Io,
pub tracing_output: Option<String>, pub tracing_output: Option<String>,
pub timer: bool, pub timer: bool,
pub headers: bool,
} }
impl From<Opts> for Settings { impl From<Opts> for Settings {
@ -107,6 +108,7 @@ impl From<Opts> for Settings {
}, },
tracing_output: opts.tracing_output, tracing_output: opts.tracing_output,
timer: false, timer: false,
headers: false,
} }
} }
} }
@ -115,7 +117,7 @@ impl std::fmt::Display for Settings {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
write!( write!(
f, f,
"Settings:\nOutput mode: {}\nDB: {}\nOutput: {}\nNull value: {}\nCWD: {}\nEcho: {}", "Settings:\nOutput mode: {}\nDB: {}\nOutput: {}\nNull value: {}\nCWD: {}\nEcho: {}\nHeaders: {}",
self.output_mode, self.output_mode,
self.db_file, self.db_file,
match self.is_stdout { match self.is_stdout {
@ -127,6 +129,10 @@ impl std::fmt::Display for Settings {
match self.echo { match self.echo {
true => "on", true => "on",
false => "off", false => "off",
},
match self.headers {
true => "on",
false => "off",
} }
) )
} }
@ -221,6 +227,12 @@ pub const AFTER_HELP_MSG: &str = r#"Usage Examples:
14. To show names of indexes: 14. To show names of indexes:
.indexes ?TABLE? .indexes ?TABLE?
15. To turn on column headers in list mode:
.headers on
16. To turn off column headers in list mode:
.headers off
Note: Note:
- All SQL commands must end with a semicolon (;). - All SQL commands must end with a semicolon (;).
- Special commands start with a dot (.) and are not required to end with a semicolon."#; - Special commands start with a dot (.) and are not required to end with a semicolon."#;