Search Results for

    Show / Hide Table of Contents
    View Source

    Class PackageMigrationRunner

    Runs the package migration plans

    Inheritance
    System.Object
    Namespace: Umbraco.Cms.Infrastructure.Install
    Assembly: Umbraco.Infrastructure.dll
    Syntax
    public class PackageMigrationRunner

    Constructors

    View Source

    PackageMigrationRunner(IProfilingLogger, ICoreScopeProvider, PendingPackageMigrations, PackageMigrationPlanCollection, IMigrationPlanExecutor, IKeyValueService, IEventAggregator, ILogger<PackageMigrationRunner>)

    Declaration
    public PackageMigrationRunner(IProfilingLogger profilingLogger, ICoreScopeProvider scopeProvider, PendingPackageMigrations pendingPackageMigrations, PackageMigrationPlanCollection packageMigrationPlans, IMigrationPlanExecutor migrationPlanExecutor, IKeyValueService keyValueService, IEventAggregator eventAggregator, ILogger<PackageMigrationRunner> logger)
    Parameters
    Type Name Description
    IProfilingLogger profilingLogger
    ICoreScopeProvider scopeProvider
    PendingPackageMigrations pendingPackageMigrations
    PackageMigrationPlanCollection packageMigrationPlans
    IMigrationPlanExecutor migrationPlanExecutor
    IKeyValueService keyValueService
    IEventAggregator eventAggregator
    ILogger<PackageMigrationRunner> logger

    Methods

    View Source

    RunPackageMigrationsIfPending(String)

    Runs all migration plans for a package name if any are pending.

    Declaration
    public IEnumerable<ExecutedMigrationPlan> RunPackageMigrationsIfPending(string packageName)
    Parameters
    Type Name Description
    System.String packageName
    Returns
    Type Description
    IEnumerable<ExecutedMigrationPlan>
    View Source

    RunPackagePlans(IEnumerable<String>)

    Runs the all specified package migration plans and publishes a MigrationPlansExecutedNotification if all are successful.

    Declaration
    public IEnumerable<ExecutedMigrationPlan> RunPackagePlans(IEnumerable<string> plansToRun)
    Parameters
    Type Name Description
    IEnumerable<System.String> plansToRun
    Returns
    Type Description
    IEnumerable<ExecutedMigrationPlan>
    View Source

    RunPendingPackageMigrations(String)

    Checks if all executed package migrations succeeded for a package.

    Declaration
    public async Task<Attempt<bool, PackageMigrationOperationStatus>> RunPendingPackageMigrations(string packageName)
    Parameters
    Type Name Description
    System.String packageName
    Returns
    Type Description
    Task<Attempt<System.Boolean, PackageMigrationOperationStatus>>
    • Improve this Doc
    • View Source
    In This Article
    • Constructors
      • PackageMigrationRunner(IProfilingLogger, ICoreScopeProvider, PendingPackageMigrations, PackageMigrationPlanCollection, IMigrationPlanExecutor, IKeyValueService, IEventAggregator, ILogger<PackageMigrationRunner>)
    • Methods
      • RunPackageMigrationsIfPending(String)
      • RunPackagePlans(IEnumerable<String>)
      • RunPendingPackageMigrations(String)
    Back to top Copyright © 2016-present Umbraco
    Generated by DocFX