DBSetupDeployTask Class

Article
11/05/2012

Represents the deployment setup tasks.

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
Assembly: Microsoft.Data.Schema.Tasks (in Microsoft.Data.Schema.Tasks.dll)

Syntax

'Declaration
Public Class DBSetupDeployTask _
    Inherits DataTask

public class DBSetupDeployTask : DataTask

public ref class DBSetupDeployTask : public DataTask

type DBSetupDeployTask =  
    class
        inherit DataTask
    end

public class DBSetupDeployTask extends DataTask

The DBSetupDeployTask type exposes the following members.

Constructors

	Name	Description
	DBSetupDeployTask	Initializes a new instance of the DBSetupDeployTask class.

Top

Properties

	Name	Description
	BuildEngine	Gets or sets the instance of the IBuildEngine object used by the task. (Inherited from Task.)
	BuildEngine2	Gets the instance of the IBuildEngine2 object used by the task. (Inherited from Task.)
	BuildEngine3	Gets the instance of the IBuildEngine3 object used by the task. (Inherited from Task.)
	CatalogPropertiesFile	Gets or sets a catalog properties file string.
	ConnectionString	Gets or sets a connection string.
	DatabaseName	Gets or sets a database name.
	DatabaseSchemaProviderName	Gets or sets a database schema provider name.
	DeployManifestName	Gets or sets a deploy manifest name.
	DeploymentConfigFile	Gets or sets a deployment configuration file string.
	DeploymentExtensionConfiguration	Gets or sets an array of deployment extension configuration tasks.
	DeploymentExtensions	Gets or sets a deployment extensions string.
	DeploymentFiles	Gets an array of deployment file tasks.
	DeploymentScriptName	Gets or sets a deployment script name.
	DeployToDatabase	Gets or sets whether to deploy to the database.
	DeployToScript	Gets or sets whether to deploy to a script.
	HelpKeywordPrefix	Gets or sets the prefix used to compose Help keywords from resource names. (Inherited from Task.)
	HostObject	Gets or sets the host object associated with the task. (Inherited from Task.)
	IsCanceled	Gets a value that indicates whether the task was canceled. (Inherited from DataTask.)
	Log	Gets an instance of a TaskLoggingHelper class containing task logging methods. (Inherited from Task.)
	OutputDirectory	Gets or sets the output directory string.
	OverwriteExistingFiles	Gets or sets whether to overwrite existing files.
	PropertiesFile	Gets or sets an array of property file tasks.
	ReferencePath	Gets or sets an array of reference path tasks.
	ServerPropertiesFile	Gets or sets a server properties file string.
	SourceModel	Gets or sets the source model task item.
	TaskResources	Gets or sets the culture-specific resources associated with the task. (Inherited from Task.)

Top

Methods

	Name	Description
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Execute	Returns the result of setup execution. (Overrides Task.Execute().)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	OnCreateDeploymentProjectBuilder	Used to create a deployment project builder.
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	WriteError	Outputs the specified error. (Inherited from DataTask.)
	WriteErrors(String, ICollection<DataSchemaError>)	Outputs the specified list of errors. (Inherited from DataTask.)
	WriteErrors(String, ErrorManager, Object)	Outputs the errors that are contained in the list of error categories. (Inherited from DataTask.)

Top

Events

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

Top

Explicit Interface Implementations

	Name	Description
	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.

Share via