DataGeneratorTask Class

Represents data generation tasks.

Inheritance Hierarchy

System.Object
  Microsoft.Build.Utilities.Task
    Microsoft.Data.Schema.Tasks.DataTask
      Microsoft.Data.Schema.Tasks.DataGeneratorTask

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

Syntax

'Declaration
Public Class DataGeneratorTask _
    Inherits DataTask

public class DataGeneratorTask : DataTask

public ref class DataGeneratorTask : public DataTask

type DataGeneratorTask =  
    class
        inherit DataTask
    end

public class DataGeneratorTask extends DataTask

The DataGeneratorTask type exposes the following members.

Constructors

	Name	Description
	DataGeneratorTask	Initializes a new instance of the DataGeneratorTask 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.)
	ConnectionString	Gets or sets a connection string.
	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.)
	PurgeTablesBeforePopulate	Gets or sets whether to purge tables before population.
	SinkConfigName	Gets or sets the sink configuration name.
	SourceFile	Gets or sets the input data generator file.
	TaskResources	Gets or sets the culture-specific resources associated with the task. (Inherited from Task.)
	Verbose	Gets or sets whether this task is set to verbose.

Top

Methods

	Name	Description
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Execute	Override. Returns the result of an attempt to execute a Data Generation plan. (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.)
	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.

See Also

Reference

Microsoft.Data.Schema.Tasks Namespace