Merge pull request 'Move convert_db command into main garage binary' (#645) from convert-db-main-binary into main

Reviewed-on: https://git.deuxfleurs.fr/Deuxfleurs/garage/pulls/645

src/db/Cargo.toml

@@ -11,11 +11,6 @@ readme = "../../README.md"
 [lib]
 path = "lib.rs"
 
-[[bin]]
-name = "convert"
-path = "bin/convert.rs"
-required-features = ["cli"]
-
 [dependencies]
 err-derive = "0.3"
 hexdump = "0.1"

src/garage/cli/convert_db.rs

@@ -1,39 +1,30 @@
 use std::path::PathBuf;
 
+use structopt::StructOpt;
+
 use garage_db::*;
 
-use clap::Parser;
-
 /// K2V command line interface
-#[derive(Parser, Debug)]
-#[clap(author, version, about, long_about = None)]
-struct Args {
-	/// Input DB path
-	#[clap(short = 'i')]
+#[derive(StructOpt, Debug)]
+pub struct ConvertDbOpt {
+	/// Input database path (not the same as metadata_dir, see
+	/// https://garagehq.deuxfleurs.fr/documentation/reference-manual/configuration/#db-engine-since-v0-8-0)
+	#[structopt(short = "i")]
 	input_path: PathBuf,
-	/// Input DB engine
-	#[clap(short = 'a')]
+	/// Input database engine (sled, lmdb or sqlite; limited by db engines
+	/// enabled in this build)
+	#[structopt(short = "a")]
 	input_engine: String,
 
-	/// Output DB path
-	#[clap(short = 'o')]
+	/// Output database path
+	#[structopt(short = "o")]
 	output_path: PathBuf,
-	/// Output DB engine
-	#[clap(short = 'b')]
+	/// Output database engine
+	#[structopt(short = "b")]
 	output_engine: String,
 }
 
-fn main() {
-	let args = Args::parse();
-	pretty_env_logger::init();
-
-	match do_conversion(args) {
-		Ok(()) => println!("Success!"),
-		Err(e) => eprintln!("Error: {}", e),
-	}
-}
-
-fn do_conversion(args: Args) -> Result<()> {
+pub(crate) fn do_conversion(args: ConvertDbOpt) -> Result<()> {
 	let input = open_db(args.input_path, args.input_engine)?;
 	let output = open_db(args.output_path, args.output_engine)?;
 	output.import(&input)?;
@@ -42,14 +33,17 @@ fn do_conversion(args: Args) -> Result<()> {
 
 fn open_db(path: PathBuf, engine: String) -> Result<Db> {
 	match engine.as_str() {
+		#[cfg(feature = "sled")]
 		"sled" => {
 			let db = sled_adapter::sled::Config::default().path(&path).open()?;
 			Ok(sled_adapter::SledDb::init(db))
 		}
+		#[cfg(feature = "sqlite")]
 		"sqlite" | "sqlite3" | "rusqlite" => {
 			let db = sqlite_adapter::rusqlite::Connection::open(&path)?;
 			Ok(sqlite_adapter::SqliteDb::init(db))
 		}
+		#[cfg(feature = "lmdb")]
 		"lmdb" | "heed" => {
 			std::fs::create_dir_all(&path).map_err(|e| {
 				Error(format!("Unable to create LMDB data directory: {}", e).into())
@@ -64,6 +58,8 @@ fn open_db(path: PathBuf, engine: String) -> Result<Db> {
 				.unwrap();
 			Ok(lmdb_adapter::LmdbDb::init(db))
 		}
-		e => Err(Error(format!("Invalid DB engine: {}", e).into())),
+		e => Err(Error(
+			format!("Invalid or unsupported DB engine: {}", e).into(),
+		)),
 	}
 }

src/garage/cli/mod.rs

@@ -4,6 +4,8 @@ pub(crate) mod layout;
 pub(crate) mod structs;
 pub(crate) mod util;
 
+pub(crate) mod convert_db;
+
 pub(crate) use cmd::*;
 pub(crate) use init::*;
 pub(crate) use layout::*;

src/garage/cli/structs.rs

@@ -3,6 +3,8 @@ use structopt::StructOpt;
 
 use garage_util::version::garage_version;
 
+use crate::cli::convert_db;
+
 #[derive(StructOpt, Debug)]
 pub enum Command {
 	/// Run Garage server
@@ -54,6 +56,10 @@ pub enum Command {
 	/// Low-level debug operations on data blocks
 	#[structopt(name = "block", version = garage_version())]
 	Block(BlockOperation),
+
+	/// Convert metadata db between database engine formats
+	#[structopt(name = "convert-db", version = garage_version())]
+	ConvertDb(convert_db::ConvertDbOpt),
 }
 
 #[derive(StructOpt, Debug)]

src/garage/main.rs

@@ -173,6 +173,9 @@ async fn main() {
 		Command::OfflineRepair(repair_opt) => {
 			repair::offline::offline_repair(opt.config_file, opt.secrets, repair_opt).await
 		}
+		Command::ConvertDb(conv_opt) => {
+			cli::convert_db::do_conversion(conv_opt).map_err(From::from)
+		}
 		Command::Node(NodeOperation::NodeId(node_id_opt)) => {
 			node_id_command(opt.config_file, node_id_opt.quiet)
 		}