View Source

Class PackageMigrationPlan

Represents a package migration plan.

Inheritance

object

MigrationPlan

Namespace: Umbraco.Cms.Core.Packaging

Assembly: Umbraco.Infrastructure.dll

Syntax

public abstract class PackageMigrationPlan : MigrationPlan, IDiscoverable

Constructors

PackageMigrationPlan(string)

Initializes a new instance of the PackageMigrationPlan class.

Declaration

protected PackageMigrationPlan(string packageName)

Parameters

Type	Name	Description
string	packageName	The package name that the plan is for. If the package has a package.manifest these must match.

PackageMigrationPlan(string, string)

Initializes a new instance of the PackageMigrationPlan class.

Declaration

protected PackageMigrationPlan(string packageName, string planName)

Parameters

Type	Name	Description
string	packageName	The package name that the plan is for. If the package has a package.manifest these must match.
string	planName	The plan name for the package. This should be the same name as the package name, if there is only one plan in the package.

PackageMigrationPlan(string, string, string)

Initializes a new instance of the PackageMigrationPlan class.

Declaration

protected PackageMigrationPlan(string packageId, string packageName, string planName)

Parameters

Type	Name	Description
string	packageId	The package identifier that the plan is for. If the package has a package.manifest these must match.
string	packageName	The package name that the plan is for. If the package has a package.manifest these must match.
string	planName	The plan name for the package. This should be the same name as the package name, if there is only one plan in the package.

Properties

IgnoreCurrentState

Inform the plan executor to ignore all saved package state and run the migration from initial state to it's end state.

Declaration

public override bool IgnoreCurrentState { get; }

Property Value

Type	Description
bool

PackageId

Gets the package identifier.

Declaration

public string? PackageId { get; init; }

Property Value

Type	Description
string	The package identifier.

PackageName

Gets the package name.

Declaration

public string PackageName { get; init; }

Property Value

Type	Description
string	The package name.

Methods

DefinePlan()

Defines the plan.

Declaration

protected abstract void DefinePlan()