DMQueryTask Class

Article
04/26/2013

Provides the properties and methods for the Data Mining Query task, which runs prediction queries based on data mining models built in Analysis Services. This class cannot be inherited.

Inheritance Hierarchy

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

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

Syntax

'Declaration
<GuidAttribute("DF3C9778-2DB4-47C6-BA5A-AFB933958F3C")> _
Public Class DMQueryTask _
    Inherits Task _
    Implements IDTSBreakpointSite, IDTSSuspend, IDTSComponentPersist, IDMQueryTask
'Usage
Dim instance As DMQueryTask

[GuidAttribute("DF3C9778-2DB4-47C6-BA5A-AFB933958F3C")]
public class DMQueryTask : Task, 
    IDTSBreakpointSite, IDTSSuspend, IDTSComponentPersist, IDMQueryTask

[GuidAttribute(L"DF3C9778-2DB4-47C6-BA5A-AFB933958F3C")]
public ref class DMQueryTask : public Task, 
    IDTSBreakpointSite, IDTSSuspend, IDTSComponentPersist, IDMQueryTask

[<GuidAttribute("DF3C9778-2DB4-47C6-BA5A-AFB933958F3C")>]
type DMQueryTask =  
    class 
        inherit Task 
        interface IDTSBreakpointSite 
        interface IDTSSuspend 
        interface IDTSComponentPersist 
        interface IDMQueryTask 
    end

public class DMQueryTask extends Task implements IDTSBreakpointSite, IDTSSuspend, IDTSComponentPersist, IDMQueryTask

The DMQueryTask type exposes the following members.

Constructors

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

Top

Properties

	Name	Description
	DebugMode	Gets or sets the Boolean value that indicates if a task should check if breakpoints are enabled.
	ExecutionValue	Gets a user-defined object. This field is read-only. (Overrides Task.ExecutionValue.)
	InputConnection	Gets or sets the connection string to an Analysis Services project or an Analysis Services database.
	InputParameters	Gets or sets a collection of variables that is used in a parameterized Data Mining Extensions (DMX) query.
	ModelName	Gets or sets the name of the mining model on which the query is based.
	ModelStructureName	Gets or sets the name of the mining structure on which the query is based.
	OutputConnection	Gets or sets the connection string to the OLE DB data source where the prediction query result will be stored.
	OutputTableName	Gets or sets the name of the table where the results of the prediction query are written.
	OverwriteOutputTable	Gets or sets the Boolean value that indicates if the prediction query should overwrite content in the destination table.
	QueryBuilderQueryString	Infrastructure. Gets or sets a string that specifies a data mining query that appears in the UI for data mining as the initial query string, which the user can the modify.
	QueryBuilderSpecification	Infrastructure. Gets or sets the information about the state of the Microsoft SQL Server Integration Services UI between sessions so that editing sessions can start from where a previous session finished.
	QueryString	Gets or sets a String that contains the text that the transformation uses to create a prediction query.
	ResultParameters	Gets or sets a collection of Integration Services variables that is used to store the DMX query results.
	SuspendRequired	Gets or sets a Boolean value that indicates if tasks should suspend when they encounter a breakpoint. This value is set by the runtime engine for tasks and containers when a breakpoint is encountered.
	Version	* Member deprecated; see Remarks. * Returns the version of the task. This property is read-only. (Inherited from Task.)

Top

Methods

	Name	Description
	AcceptBreakpointManager	Called by the run-time engine when a task or container is created, and is passed a BreakpointManager manager to allow the task to create, remove, and check the status of breakpoints. This method is called by the runtime and is not used in code.
	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 task. (Overrides Task.Execute(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging, Object).)
	ExecuteQuery	Executes the query found in the QueryString property.
	Finalize	(Inherited from 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 properties associated with the task. This method is called by the runtime and is not used in code. (Inherited from Task.)
	LoadFromXML	This method is not callable by your application code. Loads a package saved as .xml, use the Application.LoadPackage method.
	MemberwiseClone	(Inherited from Object.)
	ResumeExecution	Resumes execution of the task after pausing. The task or container is resumed by the runtime engine.
	SaveToXML	This method is not callable by your application code. Saves a package as .xml, use the Application.SaveToXml method.
	SuspendExecution	Indicates that the executable needs to suspend. This method is called by the runtime engine.
	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	Verifies that the component is properly configured. (Overrides Task.Validate(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging).)

Top

Remarks

For more information, see Data Mining Query Task.

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