DatabaseTaskHost Class

This class and its members are reserved for internal use and are not intended to be used in your code. Represents the database task host.

Inheritance Hierarchy

System.Object
  Microsoft.Data.Schema.Build.DatabaseTaskHost

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

Syntax

'Declaration
<SerializableAttribute> _
Public MustInherit Class DatabaseTaskHost _
    Implements ITaskHost, IDisposable, ISerializable

[SerializableAttribute]
public abstract class DatabaseTaskHost : ITaskHost, 
    IDisposable, ISerializable

[SerializableAttribute]
public ref class DatabaseTaskHost abstract : ITaskHost, 
    IDisposable, ISerializable

[<AbstractClass>]
[<SerializableAttribute>]
type DatabaseTaskHost =  
    class
        interface ITaskHost
        interface IDisposable
        interface ISerializable
    end

public abstract class DatabaseTaskHost implements ITaskHost, IDisposable, ISerializable

The DatabaseTaskHost type exposes the following members.

Constructors

	Name	Description
	DatabaseTaskHost(SerializationInfo, StreamingContext)	Initializes a new instance of the DatabaseTaskHost class.
	DatabaseTaskHost(DatabaseSchemaProvider, ErrorManager, Boolean, String)	Initializes a new instance of the DatabaseTaskHost class.

Top

Properties

	Name	Description
	DatabaseSchemaProvider	Gets the database schema provider for this DatabaseTaskHost.
	DataSchemaModel	Gets or sets the data schema model that is loaded with source items and that is used by the build.
	Errors	Gets the error manager.
	IdeMode	Gets a value that indicates whether IDE mode is true.
	IsAsyncModelBuildingRunning	Gets a value that indicates whether model building occurs in the background.
	IsCatalogPropertyFileValid	Gets a value that indicates whether the catalog property file is valid.
	IsOptimizedForInsert	Gets a value that indicates whether the model is optimized for insert.
	IsOptimizedForQuery	Gets a value that indicates whether the model is optimized for query.
	IsServerPropertyFileValid	Gets a value that indicates whether the server property file is valid.
	ModelBuilder	Gets the model builder used by the file manager.

Top

Methods

	Name	Description
	AddOrUpdate	Adds custom data, such as references, to the schema manager.
	BuildCanceled	Indicates whether the build was canceled.
	Dispose()	Releases resources.
	Dispose(Boolean)	Releases resources, as specified.
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetAllProperties	Returns all the properties for a given source.
	GetCatalogProperty	Returns the value of a catalog property.
	GetChangedPropertiesFromPropertiesFile	Returns a list of properties for the given configuration from the property file at fullPath where the property has either been added, deleted, or changed.
	GetDefaultValue	Returns the default value for this property from the given source.
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetObjectData	Populates a SerializationInfo with the data that is required to serialize the target object.
	GetProperty	Returns the current value for a property.
	GetServerProperty	Returns the value of a server property.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	GetWorkload	Returns the amount of work left to partially resolve the model.
	Initialize	Used when deserializing.
	InitializeConstructor(DataSchemaModelConstructor)	Initializes the constructor.
	InitializeConstructor(ModelBuilderConstructor)	Not used.
	InitializeConstructor(ParserConstructor)	Use this method to initialize the database schema provider-specific parser constructor.
	InternalGetAllProperties	Returns the actual list of properties for that source.
	IsTaskItemUnchanged	Returns a value that indicates whether the script and metadata that were last processed by the file manager represent the version of the file currently on disk.
	MatchesDataSchemaModelValue	Returns a value that indicates whether the value set on the data schema model is matched.
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	OnCreateCustomSchemaData	Returns nulla null reference (Nothing in Visual Basic).
	OnFixupAfterDeserialization	Does nothing.
	OnProcessFileListPriorToBatchLoadOrUpdate	Allows database schema provider implementations to process the file list before it is inserted into the model.
	OnProcessFileListPriorToRemove	Allows database schema provider implementations to remove files from their model builder in unique ways.
	OnReadPropertiesFile	Returns all properties read from the specified properties file.
	OnResetBuildValidationStatus	Called during a build operation just before fully resolving the model.
	OnRunBuildValidations	Use this method to visit your model to look for elements that violate any validation rules.
	OptimizeForInsert	Optimizes the file manager for insertion.
	OptimizeForQuery	Optimizes the file manager for query.
	PopulateCustomMetadataNames	Database schema provider implementations override this to provide a list of custom metadata names, such as references.
	PostInitDataSchemaModel	Called after the schema manager has been created, and enables database schema provider implementations to update any model options.
	RemoveCustomSchemaData	Removes the specified custom schema data file (for example, references) from the schema manager.
	ResetAllCatalogProperties	Resets all catalog properties to their default state, which is as if the properties file did not exist.
	ResetAllServerProperties	Resets all server properties to their default state, which is as if the properties file did not exist.
	SetAndSavePropertyFiles	Sets these properties in batch and saves the file.
	SetValue	Sets the current value for the property.
	StopAsyncModelBuilding()
	StopAsyncModelBuilding(Int32)	Stops the occurrence of async model building until AsyncModelBuildingBlocker.Dispose is called.
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	ValidateDataSchemaModel	Called to validate the current DataSchemaModel.
	ValidateValueIsBoolean	Returns a value that indicates whether the specified value is a valid Boolean.
	ValidateValueIsFloat	Returns a value that indicates whether the specified value is a valid float.
	ValidateValueIsInSet	Returns a value that indicates whether the specified value is a valid value for the data type.
	ValidateValueIsInt	Returns a value that indicates whether the specified value is a valid integer.
	VerifyConfigurationAfterSet	Used to verify any properties that are dependent on the setting of this property.

Top

Fields

	Name	Description
	NumberElementsToResolve	An integer that contains the amount of remaining work, represented as the number of model elements that must still be resolved.

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.Build Namespace