SqlRenameStep Class

Represents a step in the deployment plan that renames a element. This class is for read-only purpose and cannot be instantiated.

Inheritance Hierarchy

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

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

Syntax

'Declaration
Public NotInheritable Class SqlRenameStep _
    Inherits DeploymentScriptDomStep
'Usage
Dim instance As SqlRenameStep

public sealed class SqlRenameStep : DeploymentScriptDomStep

public ref class SqlRenameStep sealed : public DeploymentScriptDomStep

[<SealedAttribute>]
type SqlRenameStep =  
    class 
        inherit DeploymentScriptDomStep 
    end

public final class SqlRenameStep extends DeploymentScriptDomStep

The SqlRenameStep type exposes the following members.

Properties

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

Top

Methods

	Name	Description
	Equals	(Inherited from Object.)
	GenerateBatchScript	Returns a helper that writes the set of batch scripts to the provided writer. (Inherited from DeploymentStep.)
	GenerateTSQL	Returns a list of strings that represent a set of TSQL script batches to be applied during deployment (Inherited from DeploymentStepInternal.)
	GetHashCode	(Inherited from Object.)
	GetType	(Inherited from Object.)
	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