SchemaCompareScriptService.OnStartGeneratePlan Method

Called by the GenerateUpdatePlan method to provide the DatabaseSchemaProvider access to the initial provided parameter values before the update plan is generated.

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

Syntax

'Declaration
Protected Overridable Sub OnStartGeneratePlan ( _
    comparisonResult As ModelComparisonResult, _
    source As DataSchemaModel, _
    target As DataSchemaModel, _
    excludedElements As HashSet(Of IModelElement), _
    sourceModelProvider As ISchemaCompareModelProvider, _
    targetModelProvider As ISchemaCompareModelProvider, _
    options As SchemaDeploymentOptions _
)

protected virtual void OnStartGeneratePlan(
    ModelComparisonResult comparisonResult,
    DataSchemaModel source,
    DataSchemaModel target,
    HashSet<IModelElement> excludedElements,
    ISchemaCompareModelProvider sourceModelProvider,
    ISchemaCompareModelProvider targetModelProvider,
    SchemaDeploymentOptions options
)

protected:
virtual void OnStartGeneratePlan(
    ModelComparisonResult^ comparisonResult, 
    DataSchemaModel^ source, 
    DataSchemaModel^ target, 
    HashSet<IModelElement^>^ excludedElements, 
    ISchemaCompareModelProvider^ sourceModelProvider, 
    ISchemaCompareModelProvider^ targetModelProvider, 
    SchemaDeploymentOptions^ options
)

abstract OnStartGeneratePlan : 
        comparisonResult:ModelComparisonResult * 
        source:DataSchemaModel * 
        target:DataSchemaModel * 
        excludedElements:HashSet<IModelElement> * 
        sourceModelProvider:ISchemaCompareModelProvider * 
        targetModelProvider:ISchemaCompareModelProvider * 
        options:SchemaDeploymentOptions -> unit 
override OnStartGeneratePlan : 
        comparisonResult:ModelComparisonResult * 
        source:DataSchemaModel * 
        target:DataSchemaModel * 
        excludedElements:HashSet<IModelElement> * 
        sourceModelProvider:ISchemaCompareModelProvider * 
        targetModelProvider:ISchemaCompareModelProvider * 
        options:SchemaDeploymentOptions -> unit 

protected function OnStartGeneratePlan(
    comparisonResult : ModelComparisonResult, 
    source : DataSchemaModel, 
    target : DataSchemaModel, 
    excludedElements : HashSet<IModelElement>, 
    sourceModelProvider : ISchemaCompareModelProvider, 
    targetModelProvider : ISchemaCompareModelProvider, 
    options : SchemaDeploymentOptions
)

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 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.

• options
  Type: Microsoft.Data.Schema.Build.SchemaDeploymentOptions

Remarks

The default implementation does nothing, but you can override this method to modify the input parameters to the GenerateUpdatePlan method before the plan is generated.

.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