mirror of
https://github.com/nushell/nushell.git
synced 2025-05-01 00:24:29 +02:00
# Description The meaning of the word usage is specific to describing how a command function is *used* and not a synonym for general description. Usage can be used to describe the SYNOPSIS or EXAMPLES sections of a man page where the permitted argument combinations are shown or example *uses* are given. Let's not confuse people and call it what it is a description. Our `help` command already creates its own *Usage* section based on the available arguments and doesn't refer to the description with usage. # User-Facing Changes `help commands` and `scope commands` will now use `description` or `extra_description` `usage`-> `description` `extra_usage` -> `extra_description` Breaking change in the plugin protocol: In the signature record communicated with the engine. `usage`-> `description` `extra_usage` -> `extra_description` The same rename also takes place for the methods on `SimplePluginCommand` and `PluginCommand` # Tests + Formatting - Updated plugin protocol specific changes # After Submitting - [ ] update plugin protocol doc
93 lines
2.7 KiB
Rust
93 lines
2.7 KiB
Rust
use crate::database::{SQLiteDatabase, MEMORY_DB};
|
|
use nu_engine::command_prelude::*;
|
|
use nu_protocol::Signals;
|
|
|
|
#[derive(Clone)]
|
|
pub struct StorImport;
|
|
|
|
impl Command for StorImport {
|
|
fn name(&self) -> &str {
|
|
"stor import"
|
|
}
|
|
|
|
fn signature(&self) -> Signature {
|
|
Signature::build("stor import")
|
|
.input_output_types(vec![(Type::Nothing, Type::table())])
|
|
.required_named(
|
|
"file-name",
|
|
SyntaxShape::String,
|
|
"file name to import the sqlite in-memory database from",
|
|
Some('f'),
|
|
)
|
|
.allow_variants_without_examples(true)
|
|
.category(Category::Database)
|
|
}
|
|
|
|
fn description(&self) -> &str {
|
|
"Import a sqlite database file into the in-memory sqlite database."
|
|
}
|
|
|
|
fn search_terms(&self) -> Vec<&str> {
|
|
vec!["sqlite", "open", "database", "restore", "file"]
|
|
}
|
|
|
|
fn examples(&self) -> Vec<Example> {
|
|
vec![Example {
|
|
description: "Import a sqlite database file into the in-memory sqlite database",
|
|
example: "stor import --file-name nudb.sqlite",
|
|
result: None,
|
|
}]
|
|
}
|
|
|
|
fn run(
|
|
&self,
|
|
engine_state: &EngineState,
|
|
stack: &mut Stack,
|
|
call: &Call,
|
|
_input: PipelineData,
|
|
) -> Result<PipelineData, ShellError> {
|
|
let span = call.head;
|
|
let file_name_opt: Option<String> = call.get_flag(engine_state, stack, "file-name")?;
|
|
let file_name = match file_name_opt {
|
|
Some(file_name) => file_name,
|
|
None => {
|
|
return Err(ShellError::MissingParameter {
|
|
param_name: "please supply a file name with the --file-name parameter".into(),
|
|
span,
|
|
})
|
|
}
|
|
};
|
|
|
|
// Open the in-mem database
|
|
let db = Box::new(SQLiteDatabase::new(
|
|
std::path::Path::new(MEMORY_DB),
|
|
Signals::empty(),
|
|
));
|
|
|
|
if let Ok(mut conn) = db.open_connection() {
|
|
db.restore_database_from_file(&mut conn, file_name)
|
|
.map_err(|err| ShellError::GenericError {
|
|
error: "Failed to open SQLite connection in memory from import".into(),
|
|
msg: err.to_string(),
|
|
span: Some(Span::test_data()),
|
|
help: None,
|
|
inner: vec![],
|
|
})?;
|
|
}
|
|
// dbg!(db.clone());
|
|
Ok(Value::custom(db, span).into_pipeline_data())
|
|
}
|
|
}
|
|
|
|
#[cfg(test)]
|
|
mod test {
|
|
use super::*;
|
|
|
|
#[test]
|
|
fn test_examples() {
|
|
use crate::test_examples;
|
|
|
|
test_examples(StorImport {})
|
|
}
|
|
}
|