Share via


DBBuildTask Class

Represents the base build task that provides a default implementation for all build tasks.

Inheritance Hierarchy

System.Object
  Microsoft.Build.Utilities.Task
    Microsoft.Data.Schema.Tasks.DataTask
      Microsoft.Data.Schema.Tasks.DBBuildTask
        Microsoft.Data.Schema.Tasks.Sql.SqlBuildTask

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

Syntax

'Declaration
Public Class DBBuildTask _
    Inherits DataTask
public class DBBuildTask : DataTask
public ref class DBBuildTask : public DataTask
type DBBuildTask =  
    class
        inherit DataTask
    end
public class DBBuildTask extends DataTask

The DBBuildTask type exposes the following members.

Constructors

  Name Description
Public method DBBuildTask Initializes a new instance of the DBBuildTask class.

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 BuildExtensionConfiguration
Public property CatalogPropertiesFile Gets or sets the catalog properties file string.
Public property ContributorArguments
Public property DatabaseSchemaProviderName Gets or sets the database schema provider name.
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 ModelCollation Gets or sets the model collation string.
Public property OutputDBSchema Gets or sets the output database schema task item.
Public property ReferencePath Gets or sets an array of reference path task items.
Protected property SerializeModel
Public property ServerPropertiesFile Gets or sets a server properties file name.
Public property Source Gets or sets an array of source task items.
Public property SuppressWarnings Gets or sets a suppress warnings string.
Protected property TaskResources Gets or sets the culture-specific resources associated with the task. (Inherited from Task.)
Public property TreatWarningsAsErrors Gets or sets whether to treat warnings as errors.

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 build task execution. (Overrides Task.Execute().)
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 OnAddProperties Does nothing.
Protected method OnFinish Does nothing.
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 Namespace