DeploymentScriptGenerator Class

Article
11/05/2012

Represents the base implementation of a deployment script generator. By default, this implementation is used during deployment to generate a deployment script from a deployment plan.

Inheritance Hierarchy

System.Object
  Microsoft.Data.Schema.Build.DeploymentContributor
    Microsoft.Data.Schema.Build.DeploymentPlanContributor
      Microsoft.Data.Schema.Build.DeploymentPlanExecutor
        Microsoft.Data.Schema.Build.DeploymentScriptGenerator

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

Syntax

'Declaration
Public Class DeploymentScriptGenerator _
    Inherits DeploymentPlanExecutor

public class DeploymentScriptGenerator : DeploymentPlanExecutor

public ref class DeploymentScriptGenerator : public DeploymentPlanExecutor

type DeploymentScriptGenerator =  
    class
        inherit DeploymentPlanExecutor
    end

public class DeploymentScriptGenerator extends DeploymentPlanExecutor

The DeploymentScriptGenerator type exposes the following members.

Constructors

	Name	Description
	DeploymentScriptGenerator	Initializes a new instance of the DeploymentScriptGenerator class.

Top

Properties

	Name	Description
	Canceled	Gets a value that indicates whether the contributor was canceled. (Inherited from DeploymentContributor.)
	ExtensionHandle	Gets the handle for this extension. (Inherited from DeploymentPlanExecutor.)
	ScriptOutput	Gets a text writer object that can write the script.

Top

Methods

	Name	Description
	Cancel	Cancels execution of the contributor. (Inherited from DeploymentContributor.)
	Dispose()	Releases resources. (Inherited from DeploymentContributor.)
	Dispose(Boolean)	Releases resources. (Overrides DeploymentContributor.Dispose(Boolean).)
	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.)
	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.)
	OnApplyDeploymentConfiguration	Called by the deployment process in Visual Studio to give your code an opportunity to collect configuration information from the provided files. (Inherited from DeploymentContributor.)
	OnEstablishDeploymentConfiguration	Called by the deployment process in Visual Studio to give your code an opportunity to modify deployment configuration. (Inherited from DeploymentContributor.)
	OnExecute	(Overrides DeploymentPlanContributor.OnExecute(DeploymentPlanContributorContext).)
	OnPopulateArguments	Called by the Visual Studio Application Lifecycle Management (ALM) deployment engine to allow custom contributors to populate the command line arguments. (Inherited from DeploymentPlanContributor.)
	PublishMessage	Publishes a message to the deployment engine. The deployment engine will process and report the message to consumers. (Inherited from DeploymentContributor.)
	SetExtensionHandle	Sets the value of the handle of this extension. (Inherited from DeploymentPlanExecutor.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

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.

Share via