mirror of
https://github.com/XRPLF/clio.git
synced 2025-11-15 09:15:51 +00:00
8dc7f16ef1
This PR implemented the migration framework, which contains the command line interface to execute migration and helps to migrate data easily. Please read README.md for more information about this framework.
105 lines
2.7 KiB
C++
105 lines
2.7 KiB
C++
//------------------------------------------------------------------------------
|
|
/*
|
|
This file is part of clio: https://github.com/XRPLF/clio
|
|
Copyright (c) 2022-2024, the clio developers.
|
|
|
|
Permission to use, copy, modify, and distribute this software for any
|
|
purpose with or without fee is hereby granted, provided that the above
|
|
copyright notice and this permission notice appear in all copies.
|
|
|
|
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
|
|
WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
|
|
MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
|
|
ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
|
|
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
|
|
ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
|
|
OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
|
|
*/
|
|
//==============================================================================
|
|
|
|
#pragma once
|
|
|
|
#include "migration/MigrationManagerInterface.hpp"
|
|
#include "util/newconfig/ConfigDefinition.hpp"
|
|
|
|
#include <memory>
|
|
#include <string>
|
|
#include <variant>
|
|
|
|
namespace app {
|
|
|
|
/**
|
|
* @brief The command to run for migration framework
|
|
*/
|
|
struct MigrateSubCmd {
|
|
/**
|
|
* @brief Check the status of the migrations
|
|
*/
|
|
struct Status {};
|
|
/**
|
|
* @brief Run a migration
|
|
*/
|
|
struct Migration {
|
|
std::string migratorName;
|
|
};
|
|
|
|
std::variant<Status, Migration> state;
|
|
|
|
/**
|
|
* @brief Helper function to create a status command
|
|
*
|
|
* @return Cmd object containing the status command
|
|
*/
|
|
static MigrateSubCmd
|
|
status()
|
|
{
|
|
return MigrateSubCmd{Status{}};
|
|
}
|
|
|
|
/**
|
|
* @brief Helper function to create a migration command
|
|
*
|
|
* @param name The name of the migration to run
|
|
* @return Cmd object containing the migration command
|
|
*/
|
|
static MigrateSubCmd
|
|
migration(std::string const& name)
|
|
{
|
|
return MigrateSubCmd{Migration{name}};
|
|
}
|
|
};
|
|
|
|
/**
|
|
* @brief The migration application class
|
|
*/
|
|
class MigratorApplication {
|
|
std::string option_;
|
|
std::shared_ptr<migration::MigrationManagerInterface> migrationManager_;
|
|
MigrateSubCmd cmd_;
|
|
|
|
public:
|
|
/**
|
|
* @brief Construct a new MigratorApplication object
|
|
*
|
|
* @param config The configuration of the application
|
|
* @param command The command to run
|
|
*/
|
|
MigratorApplication(util::config::ClioConfigDefinition const& config, MigrateSubCmd command);
|
|
|
|
/**
|
|
* @brief Run the application
|
|
*
|
|
* @return exit code
|
|
*/
|
|
int
|
|
run();
|
|
|
|
private:
|
|
int
|
|
printStatus();
|
|
|
|
int
|
|
migrate(std::string const& name);
|
|
};
|
|
} // namespace app
|