SqlDeployTask Class

  • Article

This class and its members are reserved for internal use and are not intended to be used in your code.

Inheritance Hierarchy

System.Object
  Microsoft.Build.Utilities.Task
    Microsoft.Data.Schema.Tasks.DataTask
      Microsoft.Data.Schema.Tasks.DBDeployTask
        Microsoft.Data.Schema.Tasks.Sql.SqlDeployTask

Namespace:  Microsoft.Data.Schema.Tasks.Sql
Assembly:  Microsoft.Data.Schema.Tasks.Sql (in Microsoft.Data.Schema.Tasks.Sql.dll)

Syntax

'Declaration
Public Class SqlDeployTask _
    Inherits DBDeployTask

public class SqlDeployTask : DBDeployTask

public ref class SqlDeployTask : public DBDeployTask

type SqlDeployTask =  
    class
        inherit DBDeployTask
    end

public class SqlDeployTask extends DBDeployTask

The SqlDeployTask type exposes the following members.

Constructors

  Name Description
Public method SqlDeployTask This class and its members are reserved for internal use and are not intended to be used in your code.

Top

Properties

  Name Description
Public property BuildEngine Gets or sets the instance of the IBuildEngine object used by the task. (Inherited from Task.)
Public property BuildEngine2 Gets the instance of the IBuildEngine2 object used by the task. (Inherited from Task.)
Public property BuildEngine3 Gets the instance of the IBuildEngine3 object used by the task. (Inherited from Task.)
Public property ConnectionString Gets or sets a connection string. (Inherited from DBDeployTask.)
Public property ContributorArguments (Inherited from DBDeployTask.)
Public property DatabaseName Gets or sets the database name. (Inherited from DBDeployTask.)
Public property DeploymentConfigurationFile Gets or sets the deployment configuration file name. (Inherited from DBDeployTask.)
Public property DeploymentExtensions Gets or sets the deployment extensions string. (Inherited from DBDeployTask.)
Public property DeploymentManifest Gets or sets the deployment manifest task item. (Inherited from DBDeployTask.)
Public property DeployScriptFile Gets or sets the deploy script file name. (Inherited from DBDeployTask.)
Public property DeployToDatabase Gets or sets whether to deploy to the database. (Inherited from DBDeployTask.)
Public property DeployToScript Gets or sets whether to deploy to the script. (Inherited from DBDeployTask.)
Protected property HelpKeywordPrefix Gets or sets the prefix used to compose Help keywords from resource names. (Inherited from Task.)
Public property HostObject Gets or sets the host object associated with the task. (Inherited from Task.)
Protected property IsCanceled Gets a value that indicates whether the task was canceled. (Inherited from DataTask.)
Public property Log Gets an instance of a TaskLoggingHelper class containing task logging methods. (Inherited from Task.)
Public property SourceModel Gets or sets the source model task item. (Inherited from DBDeployTask.)
Public property SqlCommandVariableOverrides This class and its members are reserved for internal use and are not intended to be used in your code.
Public property SqlCommandVariablesFile This class and its members are reserved for internal use and are not intended to be used in your code.
Protected property TaskResources Gets or sets the culture-specific resources associated with the task. (Inherited from Task.)

Top

Methods

  Name Description
Public method Equals Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Public method Execute Returns the result of deployment execution. (Inherited from DBDeployTask.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Protected method OnInitializeConstructor (Inherited from DBDeployTask.)
Protected method OnInitializeDeployment This class and its members are reserved for internal use and are not intended to be used in your code. (Overrides DBDeployTask.OnInitializeDeployment(SchemaDeployment).)
Protected method OnStart This class and its members are reserved for internal use and are not intended to be used in your code. (Overrides DBDeployTask.OnStart().)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)
Protected method WriteError Outputs the specified error. (Inherited from DataTask.)
Protected method WriteErrors(String, ICollection<DataSchemaError>) Outputs the specified list of errors. (Inherited from DataTask.)
Protected method WriteErrors(String, ErrorManager, Object) Outputs the errors that are contained in the list of error categories. (Inherited from DataTask.)

Top

Events

  Name Description
Protected event Canceled Raised when the event is canceled. (Inherited from DataTask.)

Top

Explicit Interface Implementations

  Name Description
Explicit interface implemetationPrivate method ICancelableTask.Cancel Cancels the active operation. (Inherited from DataTask.)

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.Data.Schema.Tasks.Sql Namespace