DeploymentPlanExecutor DeploymentPlanExecutor DeploymentPlanExecutor Class

Definition

This class represents a deployment constributor that executes the deployment plan. An example of a constributor would be one who executes deployment steps to create a report about actions performed during a deployment

public abstract class DeploymentPlanExecutor : Microsoft.SqlServer.Dac.Deployment.DeploymentPlanContributor
type DeploymentPlanExecutor = class
    inherit DeploymentPlanContributor
Public MustInherit Class DeploymentPlanExecutor
Inherits DeploymentPlanContributor
Inheritance

Constructors

DeploymentPlanExecutor() DeploymentPlanExecutor() DeploymentPlanExecutor()

Methods

Cancel() Cancel() Cancel()

Cancels execution of the contributor

(Inherited from DeploymentContributor)
Dispose() Dispose() Dispose()

Inherited from Dispose()

(Inherited from DeploymentContributor)
Dispose(Boolean) Dispose(Boolean) Dispose(Boolean) Inherited from DeploymentContributor
OnApplyDeploymentConfiguration(DeploymentContributorContext, ICollection<DeploymentContributorConfigurationStream>) OnApplyDeploymentConfiguration(DeploymentContributorContext, ICollection<DeploymentContributorConfigurationStream>) OnApplyDeploymentConfiguration(DeploymentContributorContext, ICollection<DeploymentContributorConfigurationStream>)

Called by the deployment process in DacFx to give your code an opportunity to collect configuration information from the provided files. At the end of the method all streams will be disposed. Contributors that need to obtain data from the streams must read and cache the data during this method - attempts to read from the stream during a later method such as the OnExecute(DeploymentPlanContributorContext) method will fail.

(Inherited from DeploymentContributor)
OnEstablishDeploymentConfiguration(DeploymentContributorConfigurationSetup) OnEstablishDeploymentConfiguration(DeploymentContributorConfigurationSetup) OnEstablishDeploymentConfiguration(DeploymentContributorConfigurationSetup)

Called by the build process in DacFx to give your code an opportunity to modify deployment configuration.

(Inherited from DeploymentContributor)
OnExecute(DeploymentPlanContributorContext) OnExecute(DeploymentPlanContributorContext) OnExecute(DeploymentPlanContributorContext)

Called by the deployment engine to allow custom contributors to execute their unique tasks

(Inherited from DeploymentPlanContributor)
PublishMessage(ExtensibilityError) PublishMessage(ExtensibilityError) PublishMessage(ExtensibilityError)

Publishes a message to the deployment engine. The deployment engine will process and report the message to consumers.

(Inherited from DeploymentContributor)

Properties

Canceled Canceled Canceled

Gets a value that indicates whether the contributor was canceled

(Inherited from DeploymentContributor)
CancellationToken CancellationToken CancellationToken

The CancellationToken used to indicate whether contributor execution should be canceled

(Inherited from DeploymentContributor)

Applies to