Merge pull request #54 from mariuz/main

Implement database maintenance and repair features

Author: asfernandes

src/fb-cpp/DatabaseManager.cpp

@@ -30,7 +30,7 @@ using namespace fbcpp;
 using namespace fbcpp::impl;
 
 
-void DatabaseManager::execute(const DatabaseManagerOptions& options)
+void DatabaseManager::setProperties(const DatabasePropertiesOptions& options)
 {
 	StatusWrapper statusWrapper{getClient()};
 	auto builder =
@@ -65,3 +65,46 @@ void DatabaseManager::execute(const DatabaseManagerOptions& options)
 	startAction(std::vector<std::uint8_t>(buffer, buffer + length));
 	waitForCompletion();
 }
+
+
+void DatabaseManager::repair(const DatabaseRepairOptions& options)
+{
+	StatusWrapper statusWrapper{getClient()};
+	auto builder =
+		fbUnique(getClient().getUtil()->getXpbBuilder(&statusWrapper, fb::IXpbBuilder::SPB_START, nullptr, 0));
+
+	builder->insertTag(&statusWrapper, isc_action_svc_repair);
+	builder->insertString(&statusWrapper, isc_spb_dbname, options.getDatabase().c_str());
+
+	int optionsVal = 0;
+	if (options.getSweep())
+		optionsVal |= isc_spb_rpr_sweep_db;
+	if (options.getValidate())
+		optionsVal |= isc_spb_rpr_validate_db;
+	if (options.getMend())
+		optionsVal |= isc_spb_rpr_mend_db;
+	if (options.getIgnoreChecksum())
+		optionsVal |= isc_spb_rpr_ignore_checksum;
+	if (options.getKillShadows())
+		optionsVal |= isc_spb_rpr_kill_shadows;
+	if (options.getFull())
+		optionsVal |= isc_spb_rpr_full;
+	if (options.getCheckDb())
+		optionsVal |= isc_spb_rpr_check_db;
+	if (options.getIcu())
+		optionsVal |= isc_spb_rpr_icu;
+	if (options.getUpgradeDb())
+		optionsVal |= isc_spb_rpr_upgrade_db;
+
+	if (optionsVal != 0)
+		builder->insertInt(&statusWrapper, isc_spb_options, optionsVal);
+
+	if (const auto parallelWorkers = options.getParallelWorkers())
+		builder->insertInt(&statusWrapper, isc_spb_rpr_par_workers, static_cast<int>(*parallelWorkers));
+
+	const auto buffer = builder->getBuffer(&statusWrapper);
+	const auto length = builder->getBufferLength(&statusWrapper);
+
+	startAction(std::vector<std::uint8_t>(buffer, buffer + length));
+	waitForCompletion(options.getVerboseOutput());
+}

src/fb-cpp/DatabaseManager.h

@@ -26,6 +26,7 @@
 #define FBCPP_DATABASE_MANAGER_H
 
 #include "ServiceManager.h"
+#include <cstdint>
 #include <optional>
 #include <string>
 
@@ -38,7 +39,7 @@ namespace fbcpp
 	///
 	/// Represents options used to configure database properties through the service manager.
 	///
-	class DatabaseManagerOptions final
+	class DatabasePropertiesOptions final
 	{
 	public:
 		///
@@ -52,7 +53,7 @@ namespace fbcpp
 		///
 		/// Sets the database path to be configured.
 		///
-		DatabaseManagerOptions& setDatabase(const std::string& value)
+		DatabasePropertiesOptions& setDatabase(const std::string& value)
 		{
 			database = value;
 			return *this;
@@ -69,7 +70,7 @@ namespace fbcpp
 		///
 		/// Sets the replica mode.
 		///
-		DatabaseManagerOptions& setReplicaMode(ReplicaMode value)
+		DatabasePropertiesOptions& setReplicaMode(ReplicaMode value)
 		{
 			replicaMode = value;
 			return *this;
@@ -80,6 +81,231 @@ namespace fbcpp
 		std::optional<ReplicaMode> replicaMode;
 	};
 
+	///
+	/// Represents options used to run a database maintenance operation through the service manager.
+	///
+	class DatabaseRepairOptions final
+	{
+	public:
+		///
+		/// Returns the database path to be maintained.
+		///
+		const std::string& getDatabase() const
+		{
+			return database;
+		}
+
+		///
+		/// Sets the database path to be maintained.
+		///
+		DatabaseRepairOptions& setDatabase(const std::string& value)
+		{
+			database = value;
+			return *this;
+		}
+
+		///
+		/// Returns the verbose output callback.
+		///
+		const ServiceManager::VerboseOutput& getVerboseOutput() const
+		{
+			return verboseOutput;
+		}
+
+		///
+		/// Sets the verbose output callback.
+		///
+		DatabaseRepairOptions& setVerboseOutput(ServiceManager::VerboseOutput value)
+		{
+			verboseOutput = std::move(value);
+			return *this;
+		}
+
+		///
+		/// Returns the requested number of parallel workers.
+		///
+		const std::optional<std::uint32_t>& getParallelWorkers() const
+		{
+			return parallelWorkers;
+		}
+
+		///
+		/// Sets the requested number of parallel workers.
+		///
+		DatabaseRepairOptions& setParallelWorkers(std::uint32_t value)
+		{
+			parallelWorkers = value;
+			return *this;
+		}
+
+		///
+		/// Returns whether database sweep is configured to be run.
+		///
+		bool getSweep() const
+		{
+			return sweep;
+		}
+
+		///
+		/// Sets whether database sweep should be run.
+		///
+		DatabaseRepairOptions& setSweep(bool value)
+		{
+			sweep = value;
+			return *this;
+		}
+
+		///
+		/// Returns whether database validation is configured to be run.
+		///
+		bool getValidate() const
+		{
+			return validate;
+		}
+
+		///
+		/// Sets whether database validation should be run.
+		///
+		DatabaseRepairOptions& setValidate(bool value)
+		{
+			validate = value;
+			return *this;
+		}
+
+		///
+		/// Returns whether database mending is configured to be run.
+		///
+		bool getMend() const
+		{
+			return mend;
+		}
+
+		///
+		/// Sets whether database mending should be run.
+		///
+		DatabaseRepairOptions& setMend(bool value)
+		{
+			mend = value;
+			return *this;
+		}
+
+		///
+		/// Returns whether checksum verification is configured to be ignored.
+		///
+		bool getIgnoreChecksum() const
+		{
+			return ignoreChecksum;
+		}
+
+		///
+		/// Sets whether checksum verification should be ignored.
+		///
+		DatabaseRepairOptions& setIgnoreChecksum(bool value)
+		{
+			ignoreChecksum = value;
+			return *this;
+		}
+
+		///
+		/// Returns whether killing database shadows is configured to be run.
+		///
+		bool getKillShadows() const
+		{
+			return killShadows;
+		}
+
+		///
+		/// Sets whether killing database shadows should be run.
+		///
+		DatabaseRepairOptions& setKillShadows(bool value)
+		{
+			killShadows = value;
+			return *this;
+		}
+
+		///
+		/// Returns whether full validation is configured to be run.
+		///
+		bool getFull() const
+		{
+			return full;
+		}
+
+		///
+		/// Sets whether full validation should be run.
+		///
+		DatabaseRepairOptions& setFull(bool value)
+		{
+			full = value;
+			return *this;
+		}
+
+		///
+		/// Returns whether checking only metadata/structure is configured to be run.
+		///
+		bool getCheckDb() const
+		{
+			return checkDb;
+		}
+
+		///
+		/// Sets whether checking only metadata/structure should be run.
+		///
+		DatabaseRepairOptions& setCheckDb(bool value)
+		{
+			checkDb = value;
+			return *this;
+		}
+
+		///
+		/// Returns whether recreating ICU indexes is configured to be run.
+		///
+		bool getIcu() const
+		{
+			return icu;
+		}
+
+		///
+		/// Sets whether recreating ICU indexes should be run.
+		///
+		DatabaseRepairOptions& setIcu(bool value)
+		{
+			icu = value;
+			return *this;
+		}
+
+		///
+		/// Returns whether database upgrade is configured to be run.
+		///
+		bool getUpgradeDb() const
+		{
+			return upgradeDb;
+		}
+
+		///
+		/// Sets whether database upgrade should be run.
+		///
+		DatabaseRepairOptions& setUpgradeDb(bool value)
+		{
+			upgradeDb = value;
+			return *this;
+		}
+
+	private:
+		std::string database;
+		ServiceManager::VerboseOutput verboseOutput;
+		std::optional<std::uint32_t> parallelWorkers;
+		bool sweep = false;
+		bool validate = false;
+		bool mend = false;
+		bool ignoreChecksum = false;
+		bool killShadows = false;
+		bool full = false;
+		bool checkDb = false;
+		bool icu = false;
+		bool upgradeDb = false;
+	};
+
 	///
 	/// Executes configuration and maintenance operations through the Firebird service manager.
 	///
@@ -92,7 +318,12 @@ namespace fbcpp
 		///
 		/// Configures database properties using the provided options.
 		///
-		void execute(const DatabaseManagerOptions& options);
+		void setProperties(const DatabasePropertiesOptions& options);
+
+		///
+		/// Runs a repair operation using the provided options.
+		///
+		void repair(const DatabaseRepairOptions& options);
 	};
 }  // namespace fbcpp