50ae48b0a2
* Removing obsoleted code from MigrationPlanExecutor.cs & Interface * Removing obsoleted code from EmailAddressPropertyEditor.cs * Removing obsoleted class CacheRebuilder.cs * Removing obsoleted code from TextBuilder.cs * Removing obsoleted class ICacheRebuilder.cs * Removing obsoleted code from SerilogLogger.cs * Removing the use of Infrastructure IBackgroundTaskQueue.cs and replacing usage with the Core replacement * Removing obsoleted code from the FileUploadPropertyEditor.cs * Removing obsoleted code from BlockValuePropertyValueEditorBase.cs * Removing obsoleted constructors and methods from MultiNodeTreePickerPropertyEditor.cs and TextHeaderWriter.cs * Removing obsoleted code from CacheInstructionService.cs * Bumping obsoleted code from MigrationBase.cs to V18 * Removing obsoleted code from EmailSender.cs * Removing obsoleted code from BlockEditorVarianceHandler.cs * Removing obsoleted code from IBackOfficeApplicationManager.cs * Removing obsoleted code from RedirectTracker.cs & RichTextEditorPastedImages.cs
35 lines
1.8 KiB
C#
35 lines
1.8 KiB
C#
using Umbraco.Cms.Infrastructure.Migrations;
|
|
|
|
namespace Umbraco.Cms.Core.Migrations;
|
|
|
|
public interface IMigrationPlanExecutor
|
|
{
|
|
/// <summary>
|
|
/// Executes the migration plan.
|
|
/// </summary>
|
|
/// <param name="plan">The migration plan to execute.</param>
|
|
/// <param name="fromState">The state to start execution at.</param>
|
|
/// <returns><see cref="ExecutedMigrationPlan"/> containing information about the plan execution, such as completion state and the steps that ran.</returns>
|
|
/// <remarks>
|
|
/// <para>Each migration in the plan, may or may not run in a scope depending on the type of plan.</para>
|
|
/// <para>A plan can complete partially, the changes of each completed migration will be saved.</para>
|
|
/// </remarks>
|
|
[Obsolete("Use ExecutePlanAsync instead. Scheduled for removal in Umbraco 18.")]
|
|
ExecutedMigrationPlan ExecutePlan(MigrationPlan plan, string fromState);
|
|
|
|
/// <summary>
|
|
/// Executes the migration plan asynchronously.
|
|
/// </summary>
|
|
/// <param name="plan">The migration plan to execute.</param>
|
|
/// <param name="fromState">The state to start execution at.</param>
|
|
/// <returns>A Task of <see cref="ExecutedMigrationPlan"/> containing information about the plan execution, such as completion state and the steps that ran.</returns>
|
|
/// <remarks>
|
|
/// <para>Each migration in the plan, may or may not run in a scope depending on the type of plan.</para>
|
|
/// <para>A plan can complete partially, the changes of each completed migration will be saved.</para>
|
|
/// </remarks>
|
|
Task<ExecutedMigrationPlan> ExecutePlanAsync(MigrationPlan plan, string fromState)
|
|
#pragma warning disable CS0618 // Type or member is obsolete
|
|
=> Task.FromResult(ExecutePlan(plan, fromState));
|
|
#pragma warning restore CS0618 // Type or member is obsolete
|
|
}
|