SchemaCompareScriptService.OnFinishGeneratePlan Method

Called by the GenerateUpdatePlan method to provide the DatabaseSchemaProvider access to the deployment controller after the update plan has been generated, and after errors are collected.

Namespace:  Microsoft.Data.Schema.Tools.Compare.Schema
Assembly:  Microsoft.Data.Schema.Tools (in Microsoft.Data.Schema.Tools.dll)

Syntax

'Declaration
Protected Overridable Sub OnFinishGeneratePlan ( _
    comparisonResult As ModelComparisonResult, _
    source As DataSchemaModel, _
    target As DataSchemaModel, _
    excludedElements As HashSet(Of IModelElement), _
    sourceModelProvider As ISchemaCompareModelProvider, _
    targetModelProvider As ISchemaCompareModelProvider, _
    configurationOptions As SchemaDeploymentOptions, _
    plan As DeploymentPlan, _
    errorsAndWarnings As ErrorManager _
)

protected virtual void OnFinishGeneratePlan(
    ModelComparisonResult comparisonResult,
    DataSchemaModel source,
    DataSchemaModel target,
    HashSet<IModelElement> excludedElements,
    ISchemaCompareModelProvider sourceModelProvider,
    ISchemaCompareModelProvider targetModelProvider,
    SchemaDeploymentOptions configurationOptions,
    DeploymentPlan plan,
    ErrorManager errorsAndWarnings
)

protected:
virtual void OnFinishGeneratePlan(
    ModelComparisonResult^ comparisonResult, 
    DataSchemaModel^ source, 
    DataSchemaModel^ target, 
    HashSet<IModelElement^>^ excludedElements, 
    ISchemaCompareModelProvider^ sourceModelProvider, 
    ISchemaCompareModelProvider^ targetModelProvider, 
    SchemaDeploymentOptions^ configurationOptions, 
    DeploymentPlan^ plan, 
    ErrorManager^ errorsAndWarnings
)

abstract OnFinishGeneratePlan : 
        comparisonResult:ModelComparisonResult * 
        source:DataSchemaModel * 
        target:DataSchemaModel * 
        excludedElements:HashSet<IModelElement> * 
        sourceModelProvider:ISchemaCompareModelProvider * 
        targetModelProvider:ISchemaCompareModelProvider * 
        configurationOptions:SchemaDeploymentOptions * 
        plan:DeploymentPlan * 
        errorsAndWarnings:ErrorManager -> unit 
override OnFinishGeneratePlan : 
        comparisonResult:ModelComparisonResult * 
        source:DataSchemaModel * 
        target:DataSchemaModel * 
        excludedElements:HashSet<IModelElement> * 
        sourceModelProvider:ISchemaCompareModelProvider * 
        targetModelProvider:ISchemaCompareModelProvider * 
        configurationOptions:SchemaDeploymentOptions * 
        plan:DeploymentPlan * 
        errorsAndWarnings:ErrorManager -> unit 

protected function OnFinishGeneratePlan(
    comparisonResult : ModelComparisonResult, 
    source : DataSchemaModel, 
    target : DataSchemaModel, 
    excludedElements : HashSet<IModelElement>, 
    sourceModelProvider : ISchemaCompareModelProvider, 
    targetModelProvider : ISchemaCompareModelProvider, 
    configurationOptions : SchemaDeploymentOptions, 
    plan : DeploymentPlan, 
    errorsAndWarnings : ErrorManager
)

Parameters

• comparisonResult
  Type: Microsoft.Data.Schema.SchemaModel.ModelComparisonResult
  The ModelComparisonResult object.

• source
  Type: Microsoft.Data.Schema.SchemaModel.DataSchemaModel
  The source DataSchemaModel object.

• target
  Type: Microsoft.Data.Schema.SchemaModel.DataSchemaModel
  The target DataSchemaModel object.

• excludedElements
  Type: System.Collections.Generic.HashSet<IModelElement>
  A HashSet<T> that contains the IModelElement objects that are excluded by the user in the user interface (UI).

• sourceModelProvider
  Type: Microsoft.Data.Schema.Tools.Compare.Schema.ISchemaCompareModelProvider
  An ISchemaCompareModelProvider that represents the source model provider.

• targetModelProvider
  Type: Microsoft.Data.Schema.Tools.Compare.Schema.ISchemaCompareModelProvider
  An ISchemaCompareModelProvider that represents the target model provider.

• configurationOptions
  Type: Microsoft.Data.Schema.Build.SchemaDeploymentOptions
  The SchemaDeploymentOptions object that represents the configuration values that are used to update the target database.

• plan
  Type: Microsoft.Data.Schema.Build.DeploymentPlan
  The DeploymentPlan object.

• errorsAndWarnings
  Type: Microsoft.Data.Schema.ErrorManager
  An ErrorManager object that contains any errors that occurred when the plan was generated by Schema Compare.

Remarks

The default implementation does nothing, but is available for derived classes.

.NET Framework Security

• Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

See Also

Reference

SchemaCompareScriptService Class

Microsoft.Data.Schema.Tools.Compare.Schema Namespace

GenerateUpdatePlan

DatabaseSchemaProvider

ModelComparisonResult

DataSchemaModel

IModelElement

ISchemaCompareModelProvider

SchemaDeploymentOptions

DeploymentPlan

ErrorManager