DataProfilingTask Class

 

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.

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

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

public sealed class DataProfilingTask : Task, IDTSComponentPersist

NameDescription
System_CAPS_pubmethodDataProfilingTask()

Initializes a new instance of the DataProfilingTask class.

NameDescription
System_CAPS_pubpropertyDestination

Gets or sets the File connection manager or the package variable that contains the XML output that the Data Profiling task generates.

System_CAPS_pubpropertyDestinationType

Gets or sets a value whether a File connection manager or a package variable contains the XML output the Data Profiling task generates.

System_CAPS_pubpropertyExecutionValue

Returns a user-defined object. This field is read-only. (Inherited from Task.)

System_CAPS_pubpropertyOverwriteDestination

Gets or sets a value that indicates whether the Data Profiling task should overwrite the output file if the file already exists.

System_CAPS_pubpropertyProfileInputXml

This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets an XML input of the DataProfilingTask.

System_CAPS_pubpropertyProfileRequests

Gets the collection of profile requests that the Data Profiling task will compute.

System_CAPS_pubpropertyTargetServerVersion

(Inherited from Task.)

System_CAPS_pubpropertyTimeout

Gets or sets the number of seconds after which the Data Profiling task should time out and stop running.

System_CAPS_pubpropertyVersion

*** Member deprecated; see Remarks. ***   Returns the version of the task. This property is read-only.(Inherited from Task.)

NameDescription
System_CAPS_pubmethodCanUpdate(String)

*** Member deprecated; see Remarks. ***   A Boolean that indicates whether the new package XML can update the old package XML.(Inherited from Task.)

System_CAPS_pubmethodEquals(Object)

Determines whether two object instances are equal.(Inherited from DtsObject.)

System_CAPS_pubmethodExecute(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging, Object)
System_CAPS_pubmethodGetConnectionID(Connections, String)

Gets a String containing the ID of the connection.(Inherited from Task.)

System_CAPS_pubmethodGetConnectionName(Connections, String)

Gets a String containing the name of the connection.(Inherited from Task.)

System_CAPS_pubmethodGetHashCode()

Returns the hash code for this instance.(Inherited from DtsObject.)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_pubmethodInitializeTask(Connections, VariableDispenser, IDTSInfoEvents, IDTSLogging, EventInfos, LogEntryInfos, ObjectReferenceTracker)
System_CAPS_pubmethodLoadFromXML(XmlElement, IDTSInfoEvents)

Loads the definition of the task, in XML format, from the XML definition of the package.

System_CAPS_pubmethodSaveToXML(XmlDocument, IDTSInfoEvents)

Saves the definition of the task, in XML format, into the XML definition of the package.

System_CAPS_pubmethodToString()

(Inherited from Object.)

System_CAPS_pubmethodUpdate(String)

*** 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.)

System_CAPS_pubmethodValidate(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging)

Determines whether the Data Profiling task is correctly configured.(Overrides Task.Validate(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging).)

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:

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show: