DeploymentPlanGenerator Class

When implemented in a derived class by a database schema provider (DSP) vendor, generates a deployment plan that is based on a model.

Inheritance Hierarchy

System.Object
  Microsoft.Data.Schema.Build.DeploymentPlanGenerator

Namespace:  Microsoft.Data.Schema.Build
Assembly:  Microsoft.Data.Schema (in Microsoft.Data.Schema.dll)

Syntax

'Declaration
Public MustInherit Class DeploymentPlanGenerator _
    Implements IExtension
public abstract class DeploymentPlanGenerator : IExtension
public ref class DeploymentPlanGenerator abstract : IExtension
[<AbstractClass>]
type DeploymentPlanGenerator =  
    class
        interface IExtension
    end
public abstract class DeploymentPlanGenerator implements IExtension

The DeploymentPlanGenerator type exposes the following members.

Constructors

  Name Description
Protected method DeploymentPlanGenerator Initializes a new instance of the DeploymentPlanGenerator class.

Top

Properties

  Name Description
Public property ComparisonResult Gets or sets a comparison result.
Public property Messages Gets a list of messages.
Public property Options Gets or sets plan generation options.
Public property Source Gets or sets the source database model.
Public property Target Gets or sets the target database model.

Top

Methods

  Name Description
Public method Cancel Called by the Visual Studio deployment plan generation engine when the deployment operation has been canceled by the user.
Public method Equals Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GeneratePlan Called by the Visual Studio deployment plan generation engine to generate the plan.
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Protected method OnCancel Called by the Cancel method.
Protected method OnGeneratePlan Called by the GeneratePlan method to generate the plan.
Protected method OnInitialize Called by the Visual Studio deployment plan generation engine to allow your code to extend the functionality during initialization.
Protected method OnProcessProposal Called by the Visual Studio deployment plan generation engine to enable your code to extend the functionality before comparing the model.
Public method ToString Returns a string that represents the current object. (Inherited from Object.)

Top

Remarks

This class is a key extension point for custom DatabaseSchemaProvider classes.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

Microsoft.Data.Schema.Build Namespace

DatabaseSchemaProvider

Other Resources

Extending the Database Features of Visual Studio