Share via


SqlBuildTask 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.DBBuildTask
        Microsoft.Data.Schema.Tasks.Sql.SqlBuildTask

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

Syntax

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

The SqlBuildTask type exposes the following members.

Constructors

  Name Description
Public method SqlBuildTask 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 AllowDatabaseObjects This class and its members are reserved for internal use and are not intended to be used in your code.
Public property AllowServerObjects This class and its members are reserved for internal use and are not intended to be used in your code.
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 (Inherited from DBBuildTask.)
Public property CatalogPropertiesFile Gets or sets the catalog properties file string. (Inherited from DBBuildTask.)
Public property ContributorArguments (Inherited from DBBuildTask.)
Public property DatabaseSchemaProviderName Gets or sets the database schema provider name. (Inherited from DBBuildTask.)
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. (Inherited from DBBuildTask.)
Public property OutputDBSchema Gets or sets the output database schema task item. (Inherited from DBBuildTask.)
Public property PreserveHeaderComments This class and its members are reserved for internal use and are not intended to be used in your code.
Public property ReferencePath Gets or sets an array of reference path task items. (Inherited from DBBuildTask.)
Protected property SerializeModel (Inherited from DBBuildTask.)
Public property ServerPropertiesFile Gets or sets a server properties file name. (Inherited from DBBuildTask.)
Public property Source Gets or sets an array of source task items. (Inherited from DBBuildTask.)
Public property SuppressWarnings Gets or sets a suppress warnings string. (Inherited from DBBuildTask.)
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. (Inherited from DBBuildTask.)

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. (Inherited from DBBuildTask.)
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 This class and its members are reserved for internal use and are not intended to be used in your code. (Overrides DBBuildTask.OnAddProperties(Dictionary<String, String>).)
Protected method OnFinish Does nothing. (Inherited from DBBuildTask.)
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