SchemaCompareScriptService.UpdateTargetDatabase Method

Called by the Update Script Tool window of Visual Studio Premium and Visual Studio Ultimate to update the target database by using the provided deployment plan and the other parameter values.

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

Syntax

'Declaration
Public Overridable Sub UpdateTargetDatabase ( _
    comparisonResult As ModelComparisonResult, _
    source As DataSchemaModel, _
    target As DataSchemaModel, _
    options As SchemaDeploymentOptions, _
    plan As DeploymentPlan, _
    <OutAttribute> ByRef errorsAndWarnings As ErrorManager _
)

public virtual void UpdateTargetDatabase(
    ModelComparisonResult comparisonResult,
    DataSchemaModel source,
    DataSchemaModel target,
    SchemaDeploymentOptions options,
    DeploymentPlan plan,
    out ErrorManager errorsAndWarnings
)

public:
virtual void UpdateTargetDatabase(
    ModelComparisonResult^ comparisonResult, 
    DataSchemaModel^ source, 
    DataSchemaModel^ target, 
    SchemaDeploymentOptions^ options, 
    DeploymentPlan^ plan, 
    [OutAttribute] ErrorManager^% errorsAndWarnings
)

abstract UpdateTargetDatabase : 
        comparisonResult:ModelComparisonResult * 
        source:DataSchemaModel * 
        target:DataSchemaModel * 
        options:SchemaDeploymentOptions * 
        plan:DeploymentPlan * 
        errorsAndWarnings:ErrorManager byref -> unit 
override UpdateTargetDatabase : 
        comparisonResult:ModelComparisonResult * 
        source:DataSchemaModel * 
        target:DataSchemaModel * 
        options:SchemaDeploymentOptions * 
        plan:DeploymentPlan * 
        errorsAndWarnings:ErrorManager byref -> unit 

public function UpdateTargetDatabase(
    comparisonResult : ModelComparisonResult, 
    source : DataSchemaModel, 
    target : DataSchemaModel, 
    options : 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.

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

• errorsAndWarnings
  Type: Microsoft.Data.Schema.ErrorManager%
  An ErrorManager to collect any errors that occur during the update process.

Remarks

This is the basic process of the UpdateTargetDatabase method:

1. Call the OnBeforeUpdateTargetDatabase method.

2. Call the CreateDeploymentController to get your deployment manager.

3. Call the ISchemaDeploymentController.UpdateDatabase method on your deployment controller.

4. Record any errors in the errorsAndWarnings parameter value.

5. Call the OnAfterUpdateTargetDatabase method.

6. Finally, call the RaiseSyncCompletedEvent method.

.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

ModelComparisonResult

DataSchemaModel

SchemaDeploymentOptions

DeploymentPlan

ErrorManager

Other Resources

Extending the Database Features of Visual Studio