migration::MigrationManagerInterface Struct Reference

The interface for the migration manager. The migration application layer will use this interface to run the migrations. Unlike the MigrationInspectorInterface which only provides the status of migration, this interface contains the acutal migration running method. More...

#include <MigrationManagerInterface.hpp>

Inheritance diagram for migration::MigrationManagerInterface:

Collaboration diagram for migration::MigrationManagerInterface:

Public Member Functions
virtual void	runMigration (std::string const &)=0
	Run the the migration according to the given migrator's name.
Public Member Functions inherited from migration::MigrationInspectorInterface
virtual std::vector< std::tuple< std::string, MigratorStatus > >	allMigratorsStatusPairs () const =0
	Get the status of all the migrators.
virtual std::vector< std::string >	allMigratorsNames () const =0
	Get all registered migrators' names.
virtual MigratorStatus	getMigratorStatusByName (std::string const &name) const =0
	Get the status of a migrator by its name.
virtual std::string	getMigratorDescriptionByName (std::string const &name) const =0
	Get the description of a migrator by its name.
virtual bool	isBlockingClio () const =0
	Return if Clio server is blocked.

Detailed Description

The interface for the migration manager. The migration application layer will use this interface to run the migrations. Unlike the MigrationInspectorInterface which only provides the status of migration, this interface contains the acutal migration running method.

Member Function Documentation

runMigration()

virtual void migration::MigrationManagerInterface::runMigration ( std::string const & )

pure virtual

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

Implemented in migration::impl::MigrationManagerBase< SupportedMigrators >.

---

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

• /__w/clio/clio/src/migration/MigrationManagerInterface.hpp