Add several cli commands, re-structure shell

This commit is contained in:
PThorpe92
2024-12-12 23:01:32 -05:00
parent f5212b0672
commit f6473ea40d
2 changed files with 489 additions and 290 deletions

471
cli/app.rs Normal file
View File

@@ -0,0 +1,471 @@
use crate::opcodes_dictionary::OPCODE_DESCRIPTIONS;
use cli_table::{Cell, Table};
use limbo_core::{Database, RowResult, Value, IO};
use clap::{Parser, ValueEnum};
use std::{
io::{self, LineWriter, Write},
path::PathBuf,
rc::Rc,
str::FromStr,
sync::{
atomic::{AtomicUsize, Ordering},
Arc,
},
};
#[derive(Parser)]
#[command(author, version, about, long_about = None)]
pub struct Opts {
pub database: Option<PathBuf>,
pub sql: Option<String>,
#[clap(short, long, default_value_t = OutputMode::Raw)]
pub output_mode: OutputMode,
}
#[derive(ValueEnum, Copy, Clone, Debug, PartialEq, Eq)]
pub enum OutputMode {
Raw,
Pretty,
}
impl std::fmt::Display for OutputMode {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
self.to_possible_value()
.expect("no values are skipped")
.get_name()
.fmt(f)
}
}
#[derive(Debug, Clone)]
pub enum Command {
/// Quit the shell
Quit,
/// Open a database file
Open,
/// Display help message
Help,
/// Display schema for a table
Schema,
/// Set output file (stdout or file)
SetOutput,
/// Set output display mode
OutputMode,
/// Show vdbe opcodes
Opcodes,
/// Change the current working directory
Cwd,
/// Display information about settings
ShowInfo,
}
impl FromStr for Command {
type Err = String;
fn from_str(s: &str) -> Result<Self, Self::Err> {
match s {
".quit" => Ok(Self::Quit),
".open" => Ok(Self::Open),
".help" => Ok(Self::Help),
".schema" => Ok(Self::Schema),
".opcodes" => Ok(Self::Opcodes),
".mode" => Ok(Self::OutputMode),
".output" => Ok(Self::SetOutput),
".cd" => Ok(Self::Cwd),
".show" => Ok(Self::ShowInfo),
_ => Err("Unknown command".to_string()),
}
}
}
pub struct Limbo {
io: Arc<limbo_core::PlatformIO>,
writer: Box<dyn Write>,
conn: Option<Rc<limbo_core::Connection>>,
filename: Option<String>,
db_file: Option<String>,
pub interrupt_count: Arc<AtomicUsize>,
pub output_mode: OutputMode,
pub is_stdout: bool,
}
impl Limbo {
#[allow(clippy::arc_with_non_send_sync)]
pub fn new(opts: &Opts) -> anyhow::Result<Self> {
println!("Limbo v{}", env!("CARGO_PKG_VERSION"));
println!("Enter \".help\" for usage hints.");
let io = Arc::new(limbo_core::PlatformIO::new()?);
let mut db_file = None;
let conn = if let Some(path) = &opts.database {
let path = path.to_str().unwrap();
db_file = Some(path.to_string());
let db = Database::open_file(io.clone(), path)?;
Some(db.connect())
} else {
println!("No database file specified: Use .open <file> to open a database.");
None
};
Ok(Self {
io: Arc::new(limbo_core::PlatformIO::new()?),
writer: Box::new(LineWriter::new(std::io::stdout())),
filename: None,
conn,
db_file,
interrupt_count: AtomicUsize::new(0).into(),
output_mode: opts.output_mode,
is_stdout: true,
})
}
fn show_info(&mut self) {
self.writeln("------------------------------\nCurrent settings:");
self.writeln(format!("Output mode: {}", self.output_mode));
let output = self
.filename
.as_ref()
.unwrap_or(&"STDOUT".to_string())
.clone();
self.writeln(format!("Output mode: {output}"));
self.writeln(format!(
"DB filename: {}",
self.db_file.clone().unwrap_or(":none:".to_string())
));
self.writeln(format!(
"CWD: {}",
std::env::current_dir().unwrap().display()
));
let _ = self.writer.flush();
}
pub fn close(&mut self) {
self.conn.as_mut().map(|c| c.close());
}
pub fn open_db(&mut self, path: &str) -> anyhow::Result<()> {
let db = Database::open_file(self.io.clone(), path)?;
self.conn = Some(db.connect());
self.db_file = Some(path.to_string());
Ok(())
}
pub fn set_output_file(&mut self, path: &str) -> io::Result<()> {
if let Ok(file) = std::fs::File::create(path) {
self.writer = Box::new(file);
self.is_stdout = false;
return Ok(());
}
Err(io::Error::new(io::ErrorKind::NotFound, "File not found"))
}
fn set_output_stdout(&mut self) {
self.writer = Box::new(io::stdout());
self.is_stdout = true;
}
pub fn set_mode(&mut self, mode: OutputMode) {
self.output_mode = mode;
}
pub fn write<D: AsRef<[u8]>>(&mut self, data: D) -> io::Result<()> {
self.writer.write_all(data.as_ref())
}
pub fn writeln<D: AsRef<[u8]>>(&mut self, data: D) {
self.writer.write_all(data.as_ref()).unwrap();
self.writer.write_all(b"\n").unwrap();
let _ = self.writer.flush();
}
pub fn reset_interrupt_count(&self) {
self.interrupt_count
.store(0, std::sync::atomic::Ordering::SeqCst);
}
pub fn display_help_message(&mut self) {
let _ = self.writer.write_all(HELP_MSG.as_ref());
}
pub fn incr_inturrupt_count(&mut self) -> usize {
self.interrupt_count
.fetch_add(1, std::sync::atomic::Ordering::SeqCst)
}
pub fn handle_dot_command(&mut self, line: &str) {
let args: Vec<&str> = line.split_whitespace().collect();
if args.is_empty() {
return;
}
match Command::from_str(args[0]) {
Ok(Command::Quit) => {
println!("Exiting Limbo SQL Shell.");
self.close();
std::process::exit(0)
}
Ok(Command::Open) => {
if args.len() < 2 {
println!("Error: No database file specified.");
} else if self.open_db(args[1]).is_err() {
println!("Error: Unable to open database file.");
}
}
Ok(Command::Schema) => {
if self.conn.is_none() {
println!("Error: no database currently open");
return;
}
let table_name = args.get(1).copied();
let _ = self.display_schema(table_name);
}
Ok(Command::Opcodes) => {
if args.len() > 1 {
for op in &OPCODE_DESCRIPTIONS {
if op.name.eq_ignore_ascii_case(args.get(1).unwrap()) {
self.writeln(format!("{}", op));
}
}
} else {
for op in &OPCODE_DESCRIPTIONS {
println!("{}\n", op);
}
}
}
Ok(Command::OutputMode) => {
if args.len() < 2 {
println!("Error: No output mode specified.");
return;
}
match OutputMode::from_str(args[1], true) {
Ok(mode) => {
self.set_mode(mode);
}
Err(e) => {
println!("{e}");
}
}
}
Ok(Command::SetOutput) => {
if args.len() == 2 {
if let Err(e) = self.set_output_file(args[1]) {
println!("Error: {}", e);
}
} else {
self.set_output_stdout();
}
}
Ok(Command::Cwd) => {
if args.len() < 2 {
println!("USAGE: .cd <directory>");
return;
}
let _ = std::env::set_current_dir(args[1]);
}
Ok(Command::ShowInfo) => {
self.show_info();
}
Ok(Command::Help) => {
self.display_help_message();
}
_ => {
println!("Unknown command: {}", args[0]);
println!("enter: .help for all available commands");
}
}
}
pub fn query(&mut self, sql: &str) -> anyhow::Result<()> {
if self.conn.is_none() {
println!("Error: No database file specified.");
return Ok(());
}
let conn = self.conn.as_ref().unwrap().clone();
match conn.query(sql) {
Ok(Some(ref mut rows)) => match self.output_mode {
OutputMode::Raw => loop {
if self.interrupt_count.load(Ordering::SeqCst) > 0 {
println!("Query interrupted.");
return Ok(());
}
match rows.next_row() {
Ok(RowResult::Row(row)) => {
for (i, value) in row.values.iter().enumerate() {
if i > 0 {
let _ = self.write(b"|");
}
self.write(
match value {
Value::Null => "".to_string(),
Value::Integer(i) => format!("{}", i),
Value::Float(f) => format!("{:?}", f),
Value::Text(s) => s.to_string(),
Value::Blob(b) => {
format!("{}", String::from_utf8_lossy(b))
}
}
.as_bytes(),
)?;
}
self.writeln("");
}
Ok(RowResult::IO) => {
self.io.run_once()?;
}
Ok(RowResult::Done) => {
break;
}
Err(err) => {
eprintln!("{}", err);
break;
}
}
},
OutputMode::Pretty => {
if self.interrupt_count.load(Ordering::SeqCst) > 0 {
println!("Query interrupted.");
return Ok(());
}
let mut table_rows: Vec<Vec<_>> = vec![];
loop {
match rows.next_row() {
Ok(RowResult::Row(row)) => {
table_rows.push(
row.values
.iter()
.map(|value| match value {
Value::Null => "".cell(),
Value::Integer(i) => i.to_string().cell(),
Value::Float(f) => f.to_string().cell(),
Value::Text(s) => s.cell(),
Value::Blob(b) => {
format!("{}", String::from_utf8_lossy(b)).cell()
}
})
.collect(),
);
}
Ok(RowResult::IO) => {
self.io.run_once()?;
}
Ok(RowResult::Done) => break,
Err(err) => {
eprintln!("{}", err);
break;
}
}
}
let table = table_rows.table();
cli_table::print_stdout(table).unwrap();
}
},
Ok(None) => {}
Err(err) => {
eprintln!("{}", err);
}
}
// for now let's cache flush always
conn.cacheflush()?;
Ok(())
}
fn display_schema(&mut self, table: Option<&str>) -> anyhow::Result<()> {
let sql = match table {
Some(table_name) => format!(
"SELECT sql FROM sqlite_schema WHERE type IN ('table', 'index') AND tbl_name = '{}' AND name NOT LIKE 'sqlite_%'",
table_name
),
None => String::from(
"SELECT sql FROM sqlite_schema WHERE type IN ('table', 'index') AND name NOT LIKE 'sqlite_%'"
),
};
match self.conn.as_ref().unwrap().query(&sql) {
Ok(Some(ref mut rows)) => {
let mut found = false;
loop {
match rows.next_row()? {
RowResult::Row(row) => {
if let Some(Value::Text(schema)) = row.values.first() {
self.writeln(format!("{};", schema));
found = true;
}
}
RowResult::IO => {
self.io.run_once()?;
}
RowResult::Done => break,
}
}
if !found {
if let Some(table_name) = table {
self.writeln(format!("Error: Table '{}' not found.", table_name));
} else {
self.writeln("No tables or indexes found in the database.");
}
}
}
Ok(None) => {
println!("No results returned from the query.");
}
Err(err) => {
if err.to_string().contains("no such table: sqlite_schema") {
return Err(anyhow::anyhow!("Unable to access database schema. The database may be using an older SQLite version or may not be properly initialized."));
} else {
return Err(anyhow::anyhow!("Error querying schema: {}", err));
}
}
}
Ok(())
}
}
const HELP_MSG: &str = r#"
Limbo SQL Shell Help
==============
Welcome to the Limbo SQL Shell! You can execute any standard SQL command here.
In addition to standard SQL commands, the following special commands are available:
Special Commands:
-----------------
.quit Stop interpreting input stream and exit.
.open <database_file> Open and connect to a database file.
.output <mode> Change the output mode. Available modes are 'raw' and 'pretty'.
.schema <table_name> Show the schema of the specified table.
.opcodes Display all the opcodes defined by the virtual machine
.cd <directory> Change the current working directory.
.help Display this help message.
Usage Examples:
---------------
1. To quit the Limbo SQL Shell:
.quit
2. To open a database file at path './employees.db':
.open employees.db
3. To view the schema of a table named 'employees':
.schema employees
4. To list all available SQL opcodes:
.opcodes
5. To change the current output mode to 'pretty':
.mode pretty
6. Send output to STDOUT if no file is specified:
.output
7. To change the current working directory to '/tmp':
.cd /tmp
8. Show the current values of settings:
.show
Note:
-----
- All SQL commands must end with a semicolon (;).
- Special commands do not require a semicolon.
"#;

View File

@@ -1,53 +1,19 @@
mod app;
mod opcodes_dictionary; mod opcodes_dictionary;
use clap::{Parser, ValueEnum}; use clap::Parser;
use cli_table::{Cell, Table};
use limbo_core::{Database, RowResult, Value};
use opcodes_dictionary::OPCODE_DESCRIPTIONS;
use rustyline::{error::ReadlineError, DefaultEditor}; use rustyline::{error::ReadlineError, DefaultEditor};
use std::path::PathBuf;
use std::rc::Rc;
use std::sync::atomic::{AtomicUsize, Ordering}; use std::sync::atomic::{AtomicUsize, Ordering};
use std::sync::Arc; use std::sync::Arc;
#[derive(ValueEnum, Copy, Clone, Debug, PartialEq, Eq)]
enum OutputMode {
Raw,
Pretty,
}
impl std::fmt::Display for OutputMode {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
self.to_possible_value()
.expect("no values are skipped")
.get_name()
.fmt(f)
}
}
#[derive(Parser)]
#[command(author, version, about, long_about = None)]
struct Opts {
database: PathBuf,
sql: Option<String>,
#[clap(short, long, default_value_t = OutputMode::Raw)]
output_mode: OutputMode,
}
#[allow(clippy::arc_with_non_send_sync)] #[allow(clippy::arc_with_non_send_sync)]
fn main() -> anyhow::Result<()> { fn main() -> anyhow::Result<()> {
env_logger::init(); env_logger::init();
let opts = Opts::parse(); let opts = app::Opts::parse();
let path = opts.database.to_str().unwrap(); let mut app = app::Limbo::new(&opts)?;
let io = Arc::new(limbo_core::PlatformIO::new()?);
let db = Database::open_file(io.clone(), path)?;
let conn = db.connect();
let interrupt_count = Arc::new(AtomicUsize::new(0));
{ {
let interrupt_count = Arc::clone(&interrupt_count); let interrupt_count: Arc<AtomicUsize> = app.interrupt_count.clone();
ctrlc::set_handler(move || { ctrlc::set_handler(move || {
// Increment the interrupt count on Ctrl-C // Increment the interrupt count on Ctrl-C
interrupt_count.fetch_add(1, Ordering::SeqCst); interrupt_count.fetch_add(1, Ordering::SeqCst);
@@ -57,20 +23,18 @@ fn main() -> anyhow::Result<()> {
if let Some(sql) = opts.sql { if let Some(sql) = opts.sql {
if sql.trim().starts_with('.') { if sql.trim().starts_with('.') {
handle_dot_command(io.clone(), &conn, &sql)?; app.handle_dot_command(&sql);
} else { } else {
query(io.clone(), &conn, &sql, &opts.output_mode, &interrupt_count)?; app.query(&sql)?;
} }
return Ok(()); return Ok(());
} }
let mut rl = DefaultEditor::new()?; let mut rl = DefaultEditor::new()?;
let home = dirs::home_dir().unwrap(); let home = dirs::home_dir().expect("Could not determine home directory");
let history_file = home.join(".limbo_history"); let history_file = home.join(".limbo_history");
if history_file.exists() { if history_file.exists() {
rl.load_history(history_file.as_path())?; rl.load_history(history_file.as_path())?;
} }
println!("Limbo v{}", env!("CARGO_PKG_VERSION"));
println!("Enter \".help\" for usage hints.");
const PROMPT: &str = "limbo> "; const PROMPT: &str = "limbo> ";
let mut input_buff = String::new(); let mut input_buff = String::new();
let mut prompt = PROMPT.to_string(); let mut prompt = PROMPT.to_string();
@@ -82,21 +46,18 @@ fn main() -> anyhow::Result<()> {
if input_buff.is_empty() { if input_buff.is_empty() {
if line.is_empty() { if line.is_empty() {
continue; continue;
} else if line.starts_with('.') { }
if let Err(e) = handle_dot_command(io.clone(), &conn, line) { if line.starts_with('.') {
eprintln!("{}", e); app.handle_dot_command(line);
}
rl.add_history_entry(line.to_owned())?; rl.add_history_entry(line.to_owned())?;
interrupt_count.store(0, Ordering::SeqCst); app.reset_interrupt_count();
continue; continue;
} }
} }
if line.ends_with(';') { if line.ends_with(';') {
input_buff.push_str(line); input_buff.push_str(line);
input_buff.split(';').for_each(|stmt| { input_buff.split(';').for_each(|stmt| {
if let Err(e) = if let Err(e) = app.query(stmt) {
query(io.clone(), &conn, stmt, &opts.output_mode, &interrupt_count)
{
eprintln!("{}", e); eprintln!("{}", e);
} }
}); });
@@ -113,13 +74,13 @@ fn main() -> anyhow::Result<()> {
}; };
} }
rl.add_history_entry(line.to_owned())?; rl.add_history_entry(line.to_owned())?;
interrupt_count.store(0, Ordering::SeqCst); app.reset_interrupt_count();
} }
Err(ReadlineError::Interrupted) => { Err(ReadlineError::Interrupted) => {
// At prompt, increment interrupt count // At prompt, increment interrupt count
if interrupt_count.fetch_add(1, Ordering::SeqCst) >= 1 { if app.incr_inturrupt_count() >= 1 {
eprintln!("Interrupted. Exiting..."); eprintln!("Interrupted. Exiting...");
conn.close()?; app.close();
break; break;
} }
println!("Use .quit to exit or press Ctrl-C again to force quit."); println!("Use .quit to exit or press Ctrl-C again to force quit.");
@@ -127,11 +88,11 @@ fn main() -> anyhow::Result<()> {
continue; continue;
} }
Err(ReadlineError::Eof) => { Err(ReadlineError::Eof) => {
conn.close()?; app.close();
break; break;
} }
Err(err) => { Err(err) => {
conn.close()?; app.close();
anyhow::bail!(err) anyhow::bail!(err)
} }
} }
@@ -147,236 +108,3 @@ fn calc_parens_offset(input: &str) -> i32 {
_ => acc, _ => acc,
}) })
} }
fn display_help_message() {
let help_message = r#"
Limbo SQL Shell Help
==============
Welcome to the Limbo SQL Shell! You can execute any standard SQL command here.
In addition to standard SQL commands, the following special commands are available:
Special Commands:
-----------------
.quit Stop interpreting input stream and exit.
.schema <table_name> Show the schema of the specified table.
.opcodes Display all the opcodes defined by the virtual machine
.help Display this help message.
Usage Examples:
---------------
1. To quit the Limbo SQL Shell:
.quit
2. To view the schema of a table named 'employees':
.schema employees
3. To list all available SQL opcodes:
.opcodes
Note:
-----
- All SQL commands must end with a semicolon (;).
- Special commands do not require a semicolon.
"#;
println!("{}", help_message);
}
fn handle_dot_command(
io: Arc<dyn limbo_core::IO>,
conn: &Rc<limbo_core::Connection>,
line: &str,
) -> anyhow::Result<()> {
let args: Vec<&str> = line.split_whitespace().collect();
if args.is_empty() {
return Ok(());
}
match args[0] {
".quit" => {
println!("Exiting Limbo SQL Shell.");
std::process::exit(0)
}
".schema" => {
let table_name = args.get(1).copied();
display_schema(io, conn, table_name)?;
}
".opcodes" => {
if args.len() > 1 {
for op in &OPCODE_DESCRIPTIONS {
if op.name.eq_ignore_ascii_case(args.get(1).unwrap()) {
println!("{}", op);
}
}
} else {
for op in &OPCODE_DESCRIPTIONS {
println!("{}\n", op);
}
}
}
".help" => {
display_help_message();
}
_ => {
println!("Unknown command: {}", args[0]);
println!("Available commands:");
println!(" .schema <table_name> - Display the schema for a specific table");
println!(
" .opcodes - Display all the opcodes defined by the virtual machine"
);
}
}
Ok(())
}
fn display_schema(
io: Arc<dyn limbo_core::IO>,
conn: &Rc<limbo_core::Connection>,
table: Option<&str>,
) -> anyhow::Result<()> {
let sql = match table {
Some(table_name) => format!(
"SELECT sql FROM sqlite_schema WHERE type IN ('table', 'index') AND tbl_name = '{}' AND name NOT LIKE 'sqlite_%'",
table_name
),
None => String::from(
"SELECT sql FROM sqlite_schema WHERE type IN ('table', 'index') AND name NOT LIKE 'sqlite_%'"
),
};
match conn.query(sql) {
Ok(Some(ref mut rows)) => {
let mut found = false;
loop {
match rows.next_row()? {
RowResult::Row(row) => {
if let Some(Value::Text(schema)) = row.values.first() {
println!("{};", schema);
found = true;
}
}
RowResult::IO => {
io.run_once()?;
}
RowResult::Done => break,
}
}
if !found {
if let Some(table_name) = table {
println!("Error: Table '{}' not found.", table_name);
} else {
println!("No tables or indexes found in the database.");
}
}
}
Ok(None) => {
println!("No results returned from the query.");
}
Err(err) => {
if err.to_string().contains("no such table: sqlite_schema") {
return Err(anyhow::anyhow!("Unable to access database schema. The database may be using an older SQLite version or may not be properly initialized."));
} else {
return Err(anyhow::anyhow!("Error querying schema: {}", err));
}
}
}
Ok(())
}
fn query(
io: Arc<dyn limbo_core::IO>,
conn: &Rc<limbo_core::Connection>,
sql: &str,
output_mode: &OutputMode,
interrupt_count: &Arc<AtomicUsize>,
) -> anyhow::Result<()> {
match conn.query(sql) {
Ok(Some(ref mut rows)) => match output_mode {
OutputMode::Raw => loop {
if interrupt_count.load(Ordering::SeqCst) > 0 {
println!("Query interrupted.");
return Ok(());
}
match rows.next_row() {
Ok(RowResult::Row(row)) => {
for (i, value) in row.values.iter().enumerate() {
if i > 0 {
print!("|");
}
match value {
Value::Null => print!(""),
Value::Integer(i) => print!("{}", i),
Value::Float(f) => print!("{:?}", f),
Value::Text(s) => print!("{}", s),
Value::Blob(b) => {
print!("{}", String::from_utf8_lossy(b))
}
}
}
println!();
}
Ok(RowResult::IO) => {
io.run_once()?;
}
Ok(RowResult::Done) => {
break;
}
Err(err) => {
eprintln!("{}", err);
break;
}
}
},
OutputMode::Pretty => {
if interrupt_count.load(Ordering::SeqCst) > 0 {
println!("Query interrupted.");
return Ok(());
}
let mut table_rows: Vec<Vec<_>> = vec![];
loop {
match rows.next_row() {
Ok(RowResult::Row(row)) => {
table_rows.push(
row.values
.iter()
.map(|value| match value {
Value::Null => "".cell(),
Value::Integer(i) => i.to_string().cell(),
Value::Float(f) => f.to_string().cell(),
Value::Text(s) => s.cell(),
Value::Blob(b) => {
format!("{}", String::from_utf8_lossy(b)).cell()
}
})
.collect(),
);
}
Ok(RowResult::IO) => {
io.run_once()?;
}
Ok(RowResult::Done) => break,
Err(err) => {
eprintln!("{}", err);
break;
}
}
}
let table = table_rows.table();
cli_table::print_stdout(table).unwrap();
}
},
Ok(None) => {}
Err(err) => {
eprintln!("{}", err);
}
}
// for now let's cache flush always
conn.cacheflush()?;
Ok(())
}