SqlSetupDeployTask Class

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.DBSetupDeployTask
        Microsoft.Data.Schema.Tasks.Sql.SqlSetupDeployTask

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

Syntax

'Declaration
Public Class SqlSetupDeployTask _
    Inherits DBSetupDeployTask
public class SqlSetupDeployTask : DBSetupDeployTask
public ref class SqlSetupDeployTask : public DBSetupDeployTask
type SqlSetupDeployTask =  
    class
        inherit DBSetupDeployTask
    end
public class SqlSetupDeployTask extends DBSetupDeployTask

The SqlSetupDeployTask type exposes the following members.

Constructors

  Name Description
Public method SqlSetupDeployTask 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 CatalogPropertiesFile Gets or sets a catalog properties file string. (Inherited from DBSetupDeployTask.)
Public property ConnectionString Gets or sets a connection string. (Inherited from DBSetupDeployTask.)
Public property DatabaseName Gets or sets a database name. (Inherited from DBSetupDeployTask.)
Public property DatabaseSchemaProviderName Gets or sets a database schema provider name. (Inherited from DBSetupDeployTask.)
Public property DeployManifestName Gets or sets a deploy manifest name. (Inherited from DBSetupDeployTask.)
Public property DeploymentConfigFile Gets or sets a deployment configuration file string. (Inherited from DBSetupDeployTask.)
Public property DeploymentExtensionConfiguration Gets or sets an array of deployment extension configuration tasks. (Inherited from DBSetupDeployTask.)
Public property DeploymentExtensions Gets or sets a deployment extensions string. (Inherited from DBSetupDeployTask.)
Public property DeploymentFiles Gets an array of deployment file tasks. (Inherited from DBSetupDeployTask.)
Public property DeploymentScriptName Gets or sets a deployment script name. (Inherited from DBSetupDeployTask.)
Public property DeployToDatabase Gets or sets whether to deploy to the database. (Inherited from DBSetupDeployTask.)
Public property DeployToScript Gets or sets whether to deploy to a script. (Inherited from DBSetupDeployTask.)
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 OutputDirectory Gets or sets the output directory string. (Inherited from DBSetupDeployTask.)
Public property OverwriteExistingFiles Gets or sets whether to overwrite existing files. (Inherited from DBSetupDeployTask.)
Public property PostdeployItem This class and its members are reserved for internal use and are not intended to be used in your code.
Public property PredeployItem This class and its members are reserved for internal use and are not intended to be used in your code.
Public property PropertiesFile Gets or sets an array of property file tasks. (Inherited from DBSetupDeployTask.)
Public property ReferencePath Gets or sets an array of reference path tasks. (Inherited from DBSetupDeployTask.)
Public property ServerPropertiesFile Gets or sets a server properties file string. (Inherited from DBSetupDeployTask.)
Public property SourceModel Gets or sets the source model task item. (Inherited from DBSetupDeployTask.)
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 setup execution. (Inherited from DBSetupDeployTask.)
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 OnCreateDeploymentProjectBuilder This class and its members are reserved for internal use and are not intended to be used in your code. (Overrides DBSetupDeployTask.OnCreateDeploymentProjectBuilder(ExtensionManager).)
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