Class MigrationPipelineBase

Common base class for IMigrationPipeline implementations that can create and execute actions.

Inheritance

object

MigrationPipelineBase

TableauMigrationPipelineBase

Implements

IMigrationPipeline

Namespace: Tableau.Migration.Engine.Pipelines

Assembly: Tableau.Migration.dll

Syntax

public abstract class MigrationPipelineBase : IMigrationPipeline

Constructors

MigrationPipelineBase(IServiceProvider, IConfigReader)

Creates a new MigrationPipelineBase object.

Declaration

protected MigrationPipelineBase(IServiceProvider services, IConfigReader configReader)

Parameters

Type	Name	Description
IServiceProvider	services	A DI service provider to create actions with.
IConfigReader	configReader	The config reader.

Fields

ConfigReader

Gets the config reader.

Declaration

protected readonly IConfigReader ConfigReader

Field Value

Type	Description
IConfigReader

Properties

Plan

Gets the current migration plan.

Declaration

protected IMigrationPlan Plan { get; }

Property Value

Type	Description
IMigrationPlan

Remarks

Lazy evaluates the plan to avoid creating a DI cycle with the IMigration object.

Services

Gets the service provider.

Declaration

protected IServiceProvider Services { get; }

Property Value

Type	Description
IServiceProvider

Methods

BuildActions()

Builds the ordered actions in the pipeline to execute.

Declaration

public ImmutableArray<IMigrationAction> BuildActions()

Returns

Type	Description
ImmutableArray<IMigrationAction>

BuildPipeline()

Builds the pipeline of actions to execute in order.

Declaration

protected abstract IEnumerable<IMigrationAction> BuildPipeline()

Returns

Type	Description
IEnumerable<IMigrationAction>	The actions to execute in order.

CreateAction<TAction>()

Creates an action of the given type.

Declaration

protected TAction CreateAction<TAction>() where TAction : IMigrationAction

Returns

Type	Description
TAction	The created action.

Type Parameters

Name	Description
TAction	The action type.

CreateDestinationCacheLoadStrategy<TContent>()

Gets the destination cache loading strategy for the given content type.

Declaration

public virtual IContentReferenceCacheLoadStrategy<TContent> CreateDestinationCacheLoadStrategy<TContent>() where TContent : IContentReference

Returns

Type	Description
IContentReferenceCacheLoadStrategy<TContent>	The destination cache loading strategy.

Type Parameters

Name	Description
TContent	The content type.

CreateDestinationCache<TContent>()

Gets the destination cache for the given content type.

Declaration

public virtual IContentReferenceCache CreateDestinationCache<TContent>() where TContent : class, IContentReference

Returns

Type	Description
IContentReferenceCache	The destination cache.

Type Parameters

Name	Description
TContent	The content type.

CreateDestinationContentReferenceFinder<TContent>()

Gets the destination content finder for the given content type.

Declaration

public virtual IDestinationContentReferenceFinder<TContent> CreateDestinationContentReferenceFinder<TContent>() where TContent : IContentReference

Returns

Type	Description
IDestinationContentReferenceFinder<TContent>	The destination content finder.

Type Parameters

Name	Description
TContent	The content type.

CreateMigrateContentAction<TContent>()

Creates an action to migrate content of a given type.

Declaration

protected IMigrateContentAction<TContent> CreateMigrateContentAction<TContent>() where TContent : class, IContentReference

Returns

Type	Description
IMigrateContentAction<TContent>	The created content migration action.

Type Parameters

Name	Description
TContent	The content type to migrate.

CreateSourceCacheLoadStrategy<TContent>()

Gets the source cache loading strategy for the given content type.

Declaration

public virtual IContentReferenceCacheLoadStrategy<TContent> CreateSourceCacheLoadStrategy<TContent>() where TContent : IContentReference

Returns

Type	Description
IContentReferenceCacheLoadStrategy<TContent>	The source cache loading strategy.

Type Parameters

Name	Description
TContent	The content type.

CreateSourceCache<TContent>()

Gets the source cache for the given content type.

Declaration

public virtual IContentReferenceCache CreateSourceCache<TContent>() where TContent : class, IContentReference

Returns

Type	Description
IContentReferenceCache	The source cache.

Type Parameters

Name	Description
TContent	The content type.

CreateSourceContentReferenceFinder<TContent>()

Gets the source content finder for the given content type.

Declaration

public virtual ISourceContentReferenceFinder<TContent> CreateSourceContentReferenceFinder<TContent>() where TContent : IContentReference

Returns

Type	Description
ISourceContentReferenceFinder<TContent>	The source content finder.

Type Parameters

Name	Description
TContent	The content type.

GetBatchMigrator<TContent>()

Gets a batch level migrator for the given content type.

Declaration

public virtual IContentBatchMigrator<TContent> GetBatchMigrator<TContent>() where TContent : class, IContentReference

Returns

Type	Description
IContentBatchMigrator<TContent>	The batch level migrator.

Type Parameters

Name	Description
TContent	The content type.

GetContentLoader<TContent>()

Gets a loader for the given content type.

Declaration

public virtual IMigrationContentLoader<TContent> GetContentLoader<TContent>()

Returns

Type	Description
IMigrationContentLoader<TContent>	The content loader.

Type Parameters

Name	Description
TContent	The content type.

GetDestinationLockedProjectCache()

Gets the destination locked project cache.

Declaration

public virtual ILockedProjectCache GetDestinationLockedProjectCache()

Returns

Type	Description
ILockedProjectCache	The destination locked project cache.

GetItemConverter<TPrepare, TPublish>()

Gets a content item converter for the given prepare and publish types.

Declaration

public virtual IContentItemConverter<TPrepare, TPublish> GetItemConverter<TPrepare, TPublish>() where TPrepare : class where TPublish : class

Returns

Type	Description
IContentItemConverter<TPrepare, TPublish>

Type Parameters

Name	Description
TPrepare	The type being prepared.
TPublish	The publish type.

GetItemPreparer<TContent, TPrepare, TPublish>()

Gets a content item preparer for the given content and publish types.

Declaration

public virtual IContentItemPreparer<TContent, TPublish> GetItemPreparer<TContent, TPrepare, TPublish>() where TContent : class where TPrepare : class where TPublish : class

Returns

Type	Description
IContentItemPreparer<TContent, TPublish>	The content preparer.

Type Parameters

Name	Description
TContent	The content type.
TPrepare	The type being prepared.
TPublish	The publish type.

GetMigrator<TContent>()

Gets a content type level migrator for the given content type.

Declaration

public virtual IContentMigrator<TContent> GetMigrator<TContent>() where TContent : class, IContentReference

Returns

Type	Description
IContentMigrator<TContent>	The content type level migrator.

Type Parameters

Name	Description
TContent	The content type.

Implements

IMigrationPipeline