mirror of
https://github.com/aljazceru/turso.git
synced 2025-12-17 16:44:19 +01:00
fbc3d0dbc3
In the hopes of doing a good job at teaching people what Turso can do, I am adding built-in manual pages. When the CLI starts, it picks a feature at random, and tells the user that the feature exists: ``` Turso v0.2.0-pre.8 Enter ".help" for usage hints. Did you know that Turso supports Change Data Capture? Type .manual cdc to learn more. This software is ALPHA, only use for development, testing, and experimentation. Connected to a transient in-memory database. Use ".open FILENAME" to reopen on a persistent database ``` There is a lot we can do to make this feature world class: - we can automatically compile examples during compile time like rust-doc, to make sure examples used in the manuals always work - we can implement scrolling and navigation - we can document a lot more features But for now, this is a start!
118 lines
3.7 KiB
Rust
118 lines
3.7 KiB
Rust
pub mod args;
|
|
pub mod import;
|
|
|
|
use args::{
|
|
CwdArgs, DbConfigArgs, EchoArgs, ExitArgs, HeadersArgs, IndexesArgs, LoadExtensionArgs,
|
|
ManualArgs, NullValueArgs, OpcodesArgs, OpenArgs, OutputModeArgs, SchemaArgs, SetOutputArgs,
|
|
StatsArgs, TablesArgs, TimerArgs,
|
|
};
|
|
use clap::Parser;
|
|
use import::ImportArgs;
|
|
|
|
use crate::{
|
|
commands::args::CloneArgs,
|
|
input::{AFTER_HELP_MSG, BEFORE_HELP_MSG},
|
|
};
|
|
|
|
#[derive(Parser, Debug)]
|
|
#[command(
|
|
multicall = true,
|
|
arg_required_else_help(false),
|
|
before_help(BEFORE_HELP_MSG),
|
|
after_help(AFTER_HELP_MSG),
|
|
// help_template(HELP_TEMPLATE)
|
|
)]
|
|
pub struct CommandParser {
|
|
#[command(subcommand)]
|
|
pub command: Command,
|
|
}
|
|
|
|
#[derive(Debug, Clone, clap::Subcommand)]
|
|
#[command(disable_help_flag(false), disable_version_flag(true))]
|
|
pub enum Command {
|
|
/// Exit this program with return-code CODE
|
|
#[command(display_name = ".exit", alias = "ex", alias = "exi")]
|
|
Exit(ExitArgs),
|
|
/// Quit the shell
|
|
#[command(display_name = ".quit", alias = "q", alias = "qu", alias = "qui")]
|
|
Quit,
|
|
/// Open a database file
|
|
#[command(display_name = ".open")]
|
|
Open(OpenArgs),
|
|
/// Display schema for a table
|
|
#[command(display_name = ".schema")]
|
|
Schema(SchemaArgs),
|
|
/// Set output file (or stdout if empty)
|
|
#[command(name = "output", display_name = ".output")]
|
|
SetOutput(SetOutputArgs),
|
|
/// Set output display mode
|
|
#[command(name = "mode", display_name = ".mode", arg_required_else_help(false))]
|
|
OutputMode(OutputModeArgs),
|
|
/// Show vdbe opcodes
|
|
#[command(name = "opcodes", display_name = ".opcodes")]
|
|
Opcodes(OpcodesArgs),
|
|
/// Change the current working directory
|
|
#[command(name = "cd", display_name = ".cd")]
|
|
Cwd(CwdArgs),
|
|
/// Display information about settings
|
|
#[command(name = "show", display_name = ".show")]
|
|
ShowInfo,
|
|
/// Set the value of NULL to be printed in 'list' mode
|
|
#[command(name = "nullvalue", display_name = ".nullvalue")]
|
|
NullValue(NullValueArgs),
|
|
/// Toggle 'echo' mode to repeat commands before execution
|
|
#[command(display_name = ".echo")]
|
|
Echo(EchoArgs),
|
|
/// Display tables
|
|
Tables(TablesArgs),
|
|
/// Display attached databases
|
|
Databases,
|
|
/// Import data from FILE into TABLE
|
|
#[command(name = "import", display_name = ".import")]
|
|
Import(ImportArgs),
|
|
/// Loads an extension library
|
|
#[command(name = "load", display_name = ".load")]
|
|
LoadExtension(LoadExtensionArgs),
|
|
/// Dump the current database as a list of SQL statements
|
|
Dump,
|
|
/// Print or set the current configuration for the database. Currently ignored.
|
|
#[command(name = "dbconfig", display_name = ".dbconfig")]
|
|
DbConfig(DbConfigArgs),
|
|
/// Display database statistics
|
|
#[command(name = "stats", display_name = ".stats")]
|
|
Stats(StatsArgs),
|
|
/// List vfs modules available
|
|
#[command(name = "vfslist", display_name = ".vfslist")]
|
|
ListVfs,
|
|
/// Show names of indexes
|
|
#[command(name = "indexes", display_name = ".indexes")]
|
|
ListIndexes(IndexesArgs),
|
|
#[command(name = "timer", display_name = ".timer")]
|
|
Timer(TimerArgs),
|
|
/// Toggle column headers on/off in list mode
|
|
#[command(name = "headers", display_name = ".headers")]
|
|
Headers(HeadersArgs),
|
|
#[command(name = "clone", display_name = ".clone")]
|
|
Clone(CloneArgs),
|
|
/// Display manual pages for features
|
|
#[command(name = "manual", display_name = ".manual", alias = "man")]
|
|
Manual(ManualArgs),
|
|
}
|
|
|
|
const _HELP_TEMPLATE: &str = "{before-help}{name}
|
|
{usage-heading} {usage}
|
|
|
|
{all-args}{after-help}
|
|
";
|
|
|
|
#[cfg(test)]
|
|
mod tests {
|
|
use super::CommandParser;
|
|
|
|
#[test]
|
|
fn cli_assert() {
|
|
use clap::CommandFactory;
|
|
CommandParser::command().debug_assert();
|
|
}
|
|
}
|