DataProfilingTask Class

Definition

Namespace:

Microsoft.SqlServer.Dts.Tasks.DataProfilingTask

Assembly:

Microsoft.SqlServer.DataProfilingTask.dll

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.

public ref class DataProfilingTask sealed : Microsoft::SqlServer::Dts::Runtime::Task, Microsoft::SqlServer::Dts::Runtime::IDTSComponentPersist

[Microsoft.SqlServer.Dts.Runtime.DtsTask(HelpKeyword="sql13.dts.designer.dataprofilingtask.F1", LocalizationType=typeof(Microsoft.SqlServer.Dts.Tasks.DataProfilingTask.Localized), SamplesTag="SsisDataProfilingTask", TaskContact="Data Profiling Task; Microsoft Corporation; SQL Server 2019; (c) Microsoft Corporation; All Rights Reserved;http://www.microsoft.com/sql/support/default.asp;1", TaskType="DTS90", UITypeName="Microsoft.SqlServer.DataProfilingTaskUI.DataProfilingTaskUI, Microsoft.SqlServer.DataProfilingTaskUI, Version=15.0.0.0, Culture=Neutral, PublicKeyToken=89845dcd8080cc91")]
public sealed class DataProfilingTask : Microsoft.SqlServer.Dts.Runtime.Task, Microsoft.SqlServer.Dts.Runtime.IDTSComponentPersist

[<Microsoft.SqlServer.Dts.Runtime.DtsTask(HelpKeyword="sql13.dts.designer.dataprofilingtask.F1", LocalizationType=typeof(Microsoft.SqlServer.Dts.Tasks.DataProfilingTask.Localized), SamplesTag="SsisDataProfilingTask", TaskContact="Data Profiling Task; Microsoft Corporation; SQL Server 2019; (c) Microsoft Corporation; All Rights Reserved;http://www.microsoft.com/sql/support/default.asp;1", TaskType="DTS90", UITypeName="Microsoft.SqlServer.DataProfilingTaskUI.DataProfilingTaskUI, Microsoft.SqlServer.DataProfilingTaskUI, Version=15.0.0.0, Culture=Neutral, PublicKeyToken=89845dcd8080cc91")>]
type DataProfilingTask = class
    inherit Task
    interface IDTSComponentPersist

Public NotInheritable Class DataProfilingTask
Inherits Task
Implements IDTSComponentPersist

Inheritance

Object

DtsObject

Task

DataProfilingTask

Attributes

DtsTaskAttribute

Implements

IDTSComponentPersist

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:

• Data Profiling Task

• Data Profiling Task and Viewer

Constructors

DataProfilingTask()

Initializes a new instance of the DataProfilingTask class.

Properties

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	Gets or sets an XML input of the DataProfilingTask.
ProfileRequests	Gets the collection of profile requests that the Data Profiling task will compute.
TargetServerVersion	(Inherited from Task)
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)

Methods

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