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 | |
---|---|---|
DeploymentPlanGenerator | Initializes a new instance of the DeploymentPlanGenerator class. |
Top
Properties
Name | Description | |
---|---|---|
ComparisonResult | Gets or sets a comparison result. | |
Messages | Gets a list of messages. | |
Options | Gets or sets plan generation options. | |
Source | Gets or sets the source database model. | |
Target | Gets or sets the target database model. |
Top
Methods
Name | Description | |
---|---|---|
Cancel | Called by the Visual Studio deployment plan generation engine when the deployment operation has been canceled by the user. | |
Equals | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) | |
Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) | |
GeneratePlan | Called by the Visual Studio deployment plan generation engine to generate the plan. | |
GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) | |
GetType | Gets the Type of the current instance. (Inherited from Object.) | |
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) | |
OnCancel | Called by the Cancel method. | |
OnGeneratePlan | Called by the GeneratePlan method to generate the plan. | |
OnInitialize | Called by the Visual Studio deployment plan generation engine to allow your code to extend the functionality during initialization. | |
OnProcessProposal | Called by the Visual Studio deployment plan generation engine to enable your code to extend the functionality before comparing the model. | |
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