Clio develop
The XRP Ledger API server.
Loading...
Searching...
No Matches
migration::impl::MigrationManagerBase< SupportedMigrators > Class Template Reference

The migration manager implementation for Cassandra. It will run the migration for the Cassandra database. More...

#include <MigrationManagerBase.hpp>

Inheritance diagram for migration::impl::MigrationManagerBase< SupportedMigrators >:
Collaboration diagram for migration::impl::MigrationManagerBase< SupportedMigrators >:

Public Member Functions

 MigrationManagerBase (std::shared_ptr< typename SupportedMigrators::BackendType > backend, util::config::ObjectView config)
 Construct a new Cassandra Migration Manager object.
 
void runMigration (std::string const &name) override
 Run the the migration according to the given migrator's name.
 
- Public Member Functions inherited from migration::MigrationManagerInterface
- Public Member Functions inherited from migration::MigrationInspectorInterface
- Public Member Functions inherited from migration::impl::MigrationInspectorBase< SupportedMigrators >
 MigrationInspectorBase (std::shared_ptr< typename SupportedMigrators::BackendType > backend)
 Construct a new Cassandra Migration Inspector object.
 
std::vector< std::tuple< std::string, MigratorStatus > > allMigratorsStatusPairs () const override
 Get the status of all the migrators.
 
MigratorStatus getMigratorStatusByName (std::string const &name) const override
 Get the status of a migrator by its name.
 
std::vector< std::string > allMigratorsNames () const override
 Get all registered migrators' names.
 
std::string getMigratorDescriptionByName (std::string const &name) const override
 Get the description of a migrator by its name.
 
bool isBlockingClio () const override
 Return if there is uncomplete migrator blocking the server.
 

Additional Inherited Members

- Protected Attributes inherited from migration::impl::MigrationInspectorBase< SupportedMigrators >
SupportedMigrators migrators_
 

Detailed Description

template<typename SupportedMigrators>
class migration::impl::MigrationManagerBase< SupportedMigrators >

The migration manager implementation for Cassandra. It will run the migration for the Cassandra database.

Template Parameters
SupportedMigratorsThe migrators resgister that contains all the migrators

Constructor & Destructor Documentation

◆ MigrationManagerBase()

template<typename SupportedMigrators >
migration::impl::MigrationManagerBase< SupportedMigrators >::MigrationManagerBase ( std::shared_ptr< typename SupportedMigrators::BackendType > backend,
util::config::ObjectView config )
inlineexplicit

Construct a new Cassandra Migration Manager object.

Parameters
backendThe backend of the Cassandra database
configThe configuration of the migration

Member Function Documentation

◆ runMigration()

template<typename SupportedMigrators >
void migration::impl::MigrationManagerBase< SupportedMigrators >::runMigration ( std::string const & name)
inlineoverridevirtual

Run the the migration according to the given migrator's name.

Parameters
nameThe name of the migrator

Implements migration::MigrationManagerInterface.


The documentation for this class was generated from the following file: