DeploymentScriptDomStep Class

Base class for script based deployment steps. Represents a deployment step that consists of an Abstract Syntax Tree (AST) and reference to a script Domain Object Model (DOM) generator. This class is for read-only purpose.

Inheritance Hierarchy

System.Object
  Microsoft.SqlServer.Dac.Deployment.DeploymentStep
    Microsoft.SqlServer.Dac.Deployment.DeploymentStepInternal
      Microsoft.SqlServer.Dac.Deployment.DeploymentScriptDomStep
        More...

Namespace:  Microsoft.SqlServer.Dac.Deployment
Assembly:  Microsoft.SqlServer.Dac.Extensions (in Microsoft.SqlServer.Dac.Extensions.dll)

Syntax

'Declaration
Public Class DeploymentScriptDomStep _
    Inherits DeploymentStepInternal
'Usage
Dim instance As DeploymentScriptDomStep
public class DeploymentScriptDomStep : DeploymentStepInternal
public ref class DeploymentScriptDomStep : public DeploymentStepInternal
type DeploymentScriptDomStep =  
    class 
        inherit DeploymentStepInternal 
    end
public class DeploymentScriptDomStep extends DeploymentStepInternal

The DeploymentScriptDomStep type exposes the following members.

Properties

  Name Description
Public property IsMessageInFirstBatch Returns true if the step's message will be the first batch when calling GenerateTSql()
Public property Message Gets an optional message describing the step
Public property Next Gets the next step in the container, which is a LinkedListNode<T> of type DeploymentStep. (Inherited from DeploymentStep.)
Public property Previous Gets the previous step in the container, which is a LinkedListNode<T> of type DeploymentStep. (Inherited from DeploymentStep.)
Public property Script Gets the script for this step.
Public property ScriptGenerator Gets the ScriptGenerator for this step

Top

Methods

  Name Description
Public method Equals (Inherited from Object.)
Protected method Finalize (Inherited from Object.)
Public method GenerateBatchScript Returns a helper that writes the set of batch scripts to the provided writer. (Inherited from DeploymentStep.)
Public method GenerateTSQL Returns a list of strings that represent a set of TSQL script batches to be applied during deployment (Inherited from DeploymentStepInternal.)
Public method GetHashCode (Inherited from Object.)
Public method GetType (Inherited from Object.)
Protected method MemberwiseClone (Inherited from Object.)
Public method ToString Returns a string that describes this step. The base returns the type of the step (Inherited from DeploymentStepInternal.)

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.

See Also

Reference

Microsoft.SqlServer.Dac.Deployment Namespace

Inheritance Hierarchy

System.Object
  Microsoft.SqlServer.Dac.Deployment.DeploymentStep
    Microsoft.SqlServer.Dac.Deployment.DeploymentStepInternal
      Microsoft.SqlServer.Dac.Deployment.DeploymentScriptDomStep
        Microsoft.SqlServer.Dac.Deployment.AlterElementStep
        Microsoft.SqlServer.Dac.Deployment.CreateElementStep
        Microsoft.SqlServer.Dac.Deployment.DacDeleteFromTablesStep
        Microsoft.SqlServer.Dac.Deployment.DacDisableForeignKeysStep
        Microsoft.SqlServer.Dac.Deployment.DacRestoreConstraintsStep
        Microsoft.SqlServer.Dac.Deployment.DacSaveConstraintsStep
        Microsoft.SqlServer.Dac.Deployment.DropElementStep
        Microsoft.SqlServer.Dac.Deployment.SqlChangeDatabaseStep
        Microsoft.SqlServer.Dac.Deployment.SqlCreateDatabaseStep
        Microsoft.SqlServer.Dac.Deployment.SqlCreateTrackingTableStep
        Microsoft.SqlServer.Dac.Deployment.SqlDropDatabaseStep
        Microsoft.SqlServer.Dac.Deployment.SqlDropTrackingTableStep
        Microsoft.SqlServer.Dac.Deployment.SqlFinalizeDatabaseAccessStep
        Microsoft.SqlServer.Dac.Deployment.SqlMoveSchemaStep
        Microsoft.SqlServer.Dac.Deployment.SqlPrintStep
        Microsoft.SqlServer.Dac.Deployment.SqlRenameStep