View Source

Interface IMigrationPlanExecutor

Namespace: Umbraco.Cms.Core.Migrations

Assembly: Umbraco.Infrastructure.dll

Syntax

public interface IMigrationPlanExecutor

Methods

Execute(MigrationPlan, String)

Declaration

string Execute(MigrationPlan plan, string fromState)

Parameters

Type	Name	Description
MigrationPlan	plan
System.String	fromState

Returns

Type	Description
System.String

ExecutePlan(MigrationPlan, String)

Executes the migration plan.

Declaration

virtual ExecutedMigrationPlan ExecutePlan(MigrationPlan plan, string fromState)

Parameters

Type	Name	Description
MigrationPlan	plan	The migration plan to execute.
System.String	fromState	The state to start execution at.

Returns

Type	Description
ExecutedMigrationPlan	ExecutedMigrationPlan containing information about the plan execution, such as completion state and the steps that ran.

Remarks

Each migration in the plan, may or may not run in a scope depending on the type of plan.

A plan can complete partially, the changes of each completed migration will be saved.

ExecutePlanAsync(MigrationPlan, String)

Executes the migration plan asynchronously.

Declaration

virtual Task<ExecutedMigrationPlan> ExecutePlanAsync(MigrationPlan plan, string fromState)

Parameters

Type	Name	Description
MigrationPlan	plan	The migration plan to execute.
System.String	fromState	The state to start execution at.

Returns

Type	Description
Task<ExecutedMigrationPlan>	A Task of ExecutedMigrationPlan containing information about the plan execution, such as completion state and the steps that ran.

Remarks

Each migration in the plan, may or may not run in a scope depending on the type of plan.

A plan can complete partially, the changes of each completed migration will be saved.