DataProfilingTask Class

Article
04/26/2013

Profiles selected columns and column relationships in a data source to discover the structure of an unfamiliar data source, and to identify problems with the data.

Inheritance Hierarchy

System.Object
  Microsoft.SqlServer.Dts.Runtime.DtsObject
    Microsoft.SqlServer.Dts.Runtime.Task
      Microsoft.SqlServer.Dts.Tasks.DataProfilingTask.DataProfilingTask

Namespace: Microsoft.SqlServer.Dts.Tasks.DataProfilingTask
Assembly: Microsoft.SqlServer.DataProfilingTask (in Microsoft.SqlServer.DataProfilingTask.dll)

Syntax

'Declaration
Public NotInheritable Class DataProfilingTask _
    Inherits Task _
    Implements IDTSComponentPersist
'Usage
Dim instance As DataProfilingTask

public sealed class DataProfilingTask : Task, 
    IDTSComponentPersist

public ref class DataProfilingTask sealed : public Task, 
    IDTSComponentPersist

[<SealedAttribute>]
type DataProfilingTask =  
    class 
        inherit Task 
        interface IDTSComponentPersist 
    end

public final class DataProfilingTask extends Task implements IDTSComponentPersist

The DataProfilingTask type exposes the following members.

Constructors

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

Top

Properties

	Name	Description
	Destination	Gets or sets the File connection manager or the package variable that contains the XML output that the Data Profiling task generates.
	DestinationType	Gets or sets a value whether a File connection manager or a package variable contains the XML output the Data Profiling task generates.
	ExecutionValue	Returns a user-defined object. This field is read-only. (Inherited from Task.)
	OverwriteDestination	Gets or sets a value that indicates whether the Data Profiling task should overwrite the output file if the file already exists.
	ProfileInputXml	Infrastructure. Gets or sets an XML input of the DataProfilingTask.
	ProfileRequests	Gets the collection of profile requests that the Data Profiling task will compute.
	Timeout	Gets or sets the number of seconds after which the Data Profiling task should time out and stop running.
	Version	* Member deprecated; see Remarks. * Returns the version of the task. This property is read-only. (Inherited from Task.)

Top

Methods

	Name	Description
	CanUpdate	* Member deprecated; see Remarks. * A Boolean that indicates whether the new package XML can update the old package XML. (Inherited from Task.)
	Equals	Determines whether two object instances are equal. (Inherited from DtsObject.)
	Execute	Runs the Data Profiling task. (Overrides Task.Execute(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging, Object).)
	GetConnectionID	Gets a String containing the ID of the connection. (Inherited from Task.)
	GetConnectionName	Gets a String containing the name of the connection. (Inherited from Task.)
	GetHashCode	Returns the hash code for this instance. (Inherited from DtsObject.)
	GetType	(Inherited from Object.)
	InitializeTask	Initializes the Data Profiling task. (Overrides Task.InitializeTask(Connections, VariableDispenser, IDTSInfoEvents, IDTSLogging, EventInfos, LogEntryInfos, ObjectReferenceTracker).)
	LoadFromXML	Loads the definition of the task, in XML format, from the XML definition of the package.
	SaveToXML	Saves the definition of the task, in XML format, into the XML definition of the package.
	ToString	(Inherited from Object.)
	Update	* Member deprecated; see Remarks. * This method updates the old package XML with the new package XML if CanUpdate is set to true. (Inherited from Task.)
	Validate	Determines whether the Data Profiling task is correctly configured. (Overrides Task.Validate(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging).)

Top

Remarks

The DataProfilingTask class is the main class in the Microsoft.SqlServer.Dts.Tasks.DataProfilingTask namespace. This class represents the Integration Services Data Profiling task, which can be used to profile and discover the structure of an unfamiliar data source, and to identify problems with the data.

For more information about the Data Profiling task, see the following topics:

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