View Source

Class Upgrader

Used to run a MigrationPlan

Inheritance
object
Namespace: Umbraco.Cms.Infrastructure.Migrations.Upgrade
Assembly: Umbraco.Infrastructure.dll
Syntax
public class Upgrader

Constructors

View Source

Upgrader(MigrationPlan)

Initializes a new instance of the class.

Declaration
public Upgrader(MigrationPlan plan)
Parameters
Type Name Description
MigrationPlan plan

Properties

View Source

Name

Gets the name of the migration plan.

Declaration
public string Name { get; }
Property Value
Type Description
string
View Source

Plan

Gets the migration plan.

Declaration
public MigrationPlan Plan { get; }
Property Value
Type Description
MigrationPlan
View Source

StateValueKey

Gets the key for the state value.

Declaration
public virtual string StateValueKey { get; }
Property Value
Type Description
string

Methods

View Source

Execute(IMigrationPlanExecutor, ICoreScopeProvider, IKeyValueService)

Declaration
[Obsolete("Use ExecuteAsync instead. Scheduled for removal in Umbraco 18.")]
public ExecutedMigrationPlan Execute(IMigrationPlanExecutor migrationPlanExecutor, ICoreScopeProvider scopeProvider, IKeyValueService keyValueService)
Parameters
Type Name Description
IMigrationPlanExecutor migrationPlanExecutor
ICoreScopeProvider scopeProvider
IKeyValueService keyValueService
Returns
Type Description
ExecutedMigrationPlan
View Source

ExecuteAsync(IMigrationPlanExecutor, ICoreScopeProvider, IKeyValueService)

Executes.

Declaration
public Task<ExecutedMigrationPlan> ExecuteAsync(IMigrationPlanExecutor migrationPlanExecutor, ICoreScopeProvider scopeProvider, IKeyValueService keyValueService)
Parameters
Type Name Description
IMigrationPlanExecutor migrationPlanExecutor
ICoreScopeProvider scopeProvider

A scope provider.
IKeyValueService keyValueService

A key-value service.
Returns
Type Description
Task<ExecutedMigrationPlan>