KlusterKite  0.0.0
A framework to create scalable and redundant services based on awesome Akka.Net project.
KlusterKite.NodeManager.Migrator.IMigrator Interface Reference

Base class for all cluster system migrations More...

Inheritance diagram for KlusterKite.NodeManager.Migrator.IMigrator:
KlusterKite.NodeManager.Migrator.EF.BaseDatabaseMigrator< TContext > KlusterKite.NodeManager.Mock.MockResourceMigrator KlusterKite.NodeManager.Tests.Migrations.TestMigrator KlusterKite.NodeManager.Mock.MockResourceMigratorDependence KlusterKite.NodeManager.Mock.MockResourceMigratorDependent KlusterKite.NodeManager.Tests.Migrations.TestMigrator.Dependence KlusterKite.NodeManager.Tests.Migrations.TestMigrator.Dependent

Public Member Functions

IEnumerable< ResourceIdGetMigratableResources ()
 Gets the list of cluster resources that this migrator can migrate More...
 
string GetCurrentPoint (ResourceId resourceId)
 Gets the current configuration migration point for specified resource More...
 
IEnumerable< string > Migrate (ResourceId resourceId, string pointToMigrate)
 Performs the migration procedure More...
 
IEnumerable< string > GetAllPoints ()
 Gets all possible migration points defined in this assembly More...
 

Properties

string LatestPoint [get]
 Gets the latest known migration point identification for this assembly More...
 
string Name [get]
 Gets the human-readable migrator name More...
 
EnResourceDependencyType DependencyType [get]
 Gets the type of resource dependency More...
 
decimal Priority [get]
 Gets the priority of execution. In case of migration, the migrators will be run in order of priority from largest to lowest More...
 

Detailed Description

Base class for all cluster system migrations

Definition at line 17 of file IMigrator.cs.

Member Function Documentation

◆ GetAllPoints()

IEnumerable<string> KlusterKite.NodeManager.Migrator.IMigrator.GetAllPoints ( )

Gets all possible migration points defined in this assembly

Returns
The list of migration points

Implemented in KlusterKite.NodeManager.Migrator.EF.BaseDatabaseMigrator< TContext >, KlusterKite.NodeManager.Tests.Migrations.TestMigrator, and KlusterKite.NodeManager.Mock.MockResourceMigrator.

◆ GetCurrentPoint()

string KlusterKite.NodeManager.Migrator.IMigrator.GetCurrentPoint ( ResourceId  resourceId)

Gets the current configuration migration point for specified resource

Parameters
resourceIdThe resource id
Returns
The current resource point

Implemented in KlusterKite.NodeManager.Tests.Migrations.TestMigrator, KlusterKite.NodeManager.Migrator.EF.BaseDatabaseMigrator< TContext >, and KlusterKite.NodeManager.Mock.MockResourceMigrator.

◆ GetMigratableResources()

IEnumerable<ResourceId> KlusterKite.NodeManager.Migrator.IMigrator.GetMigratableResources ( )

Gets the list of cluster resources that this migrator can migrate

Returns
The list of migratable resources

Implemented in KlusterKite.NodeManager.Tests.Migrations.TestMigrator, KlusterKite.NodeManager.Mock.MockResourceMigrator, and KlusterKite.NodeManager.Migrator.EF.BaseDatabaseMigrator< TContext >.

◆ Migrate()

IEnumerable<string> KlusterKite.NodeManager.Migrator.IMigrator.Migrate ( ResourceId  resourceId,
string  pointToMigrate 
)

Performs the migration procedure

Parameters
resourceIdThe resource id.
pointToMigrateThe point to migrate.
Returns
The list of log messages

Implemented in KlusterKite.NodeManager.Tests.Migrations.TestMigrator, KlusterKite.NodeManager.Mock.MockResourceMigrator, and KlusterKite.NodeManager.Migrator.EF.BaseDatabaseMigrator< TContext >.

Property Documentation

◆ DependencyType

EnResourceDependencyType KlusterKite.NodeManager.Migrator.IMigrator.DependencyType
get

Gets the type of resource dependency

Definition at line 32 of file IMigrator.cs.

◆ LatestPoint

string KlusterKite.NodeManager.Migrator.IMigrator.LatestPoint
get

Gets the latest known migration point identification for this assembly

Definition at line 22 of file IMigrator.cs.

◆ Name

string KlusterKite.NodeManager.Migrator.IMigrator.Name
get

Gets the human-readable migrator name

Definition at line 27 of file IMigrator.cs.

◆ Priority

decimal KlusterKite.NodeManager.Migrator.IMigrator.Priority
get

Gets the priority of execution. In case of migration, the migrators will be run in order of priority from largest to lowest

Definition at line 37 of file IMigrator.cs.


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