path: root/src/garage/cli/convert_db.rs

use std::path::PathBuf;

use structopt::StructOpt;

use garage_db::*;

/// K2V command line interface
#[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 database engine (sled, lmdb or sqlite; limited by db engines
	/// enabled in this build)
	#[structopt(short = "a")]
	input_engine: Engine,

	/// Output database path
	#[structopt(short = "o")]
	output_path: PathBuf,
	/// Output database engine
	#[structopt(short = "b")]
	output_engine: Engine,

	#[structopt(flatten)]
	db_open: OpenDbOpt,
}

/// Overrides for database open operation
#[derive(StructOpt, Debug, Default)]
pub struct OpenDbOpt {
	#[cfg(feature = "lmdb")]
	#[structopt(flatten)]
	lmdb: OpenLmdbOpt,
}

/// Overrides for LMDB database open operation
#[cfg(feature = "lmdb")]
#[derive(StructOpt, Debug, Default)]
pub struct OpenLmdbOpt {
	/// LMDB map size override
	/// (supported suffixes: B, KiB, MiB, GiB, TiB, PiB)
	#[cfg(feature = "lmdb")]
	#[structopt(long = "lmdb-map-size", name = "bytes", display_order = 1_000)]
	map_size: Option<bytesize::ByteSize>,
}

pub(crate) fn do_conversion(args: ConvertDbOpt) -> Result<()> {
	if args.input_engine == args.output_engine {
		return Err(Error("input and output database engine must differ".into()));
	}

	let input = open_db(args.input_path, args.input_engine, &args.db_open)?;
	let output = open_db(args.output_path, args.output_engine, &args.db_open)?;
	output.import(&input)?;
	Ok(())
}

fn open_db(path: PathBuf, engine: Engine, open: &OpenDbOpt) -> Result<Db> {
	match engine {
		#[cfg(feature = "sled")]
		Engine::Sled => {
			let db = sled_adapter::sled::Config::default().path(&path).open()?;
			Ok(sled_adapter::SledDb::init(db))
		}
		#[cfg(feature = "sqlite")]
		Engine::Sqlite => {
			let db = sqlite_adapter::rusqlite::Connection::open(&path)?;
			db.pragma_update(None, "journal_mode", "WAL")?;
			db.pragma_update(None, "synchronous", "NORMAL")?;
			Ok(sqlite_adapter::SqliteDb::init(db))
		}
		#[cfg(feature = "lmdb")]
		Engine::Lmdb => {
			std::fs::create_dir_all(&path).map_err(|e| {
				Error(format!("Unable to create LMDB data directory: {}", e).into())
			})?;

			let map_size = match open.lmdb.map_size {
				Some(c) => c.as_u64() as usize,
				None => lmdb_adapter::recommended_map_size(),
			};

			let mut env_builder = lmdb_adapter::heed::EnvOpenOptions::new();
			env_builder.max_dbs(100);
			env_builder.map_size(map_size);
			unsafe {
				env_builder.flag(lmdb_adapter::heed::flags::Flags::MdbNoMetaSync);
			}
			let db = env_builder.open(&path)?;
			Ok(lmdb_adapter::LmdbDb::init(db))
		}

		// Pattern is unreachable when all supported DB engines are compiled into binary. The allow
		// attribute is added so that we won't have to change this match in case stop building
		// support for one or more engines by default.
		#[allow(unreachable_patterns)]
		engine => Err(Error(
			format!("Engine support not available in this build: {}", engine).into(),
		)),
	}
}