DMQueryTask Class

Definition

Namespace:

Microsoft.SqlServer.Dts.Tasks.DMQueryTask

Assembly:

Microsoft.SqlServer.DMQueryTask.dll

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.

public ref class DMQueryTask : Microsoft::SqlServer::Dts::Runtime::Task, Microsoft::SqlServer::Dts::Runtime::IDTSBreakpointSite, Microsoft::SqlServer::Dts::Runtime::IDTSComponentPersist, Microsoft::SqlServer::Dts::Tasks::DMQueryTask::IDMQueryTask

[System.Runtime.InteropServices.Guid("115AC6A7-F095-450F-A8DF-72A07052A146")]
[Microsoft.SqlServer.Dts.Runtime.DtsTask(IconResource="Microsoft.SqlServer.Dts.Tasks.DMQueryTask.Graphics.DMQueryTask.ico", LocalizationType=typeof(Microsoft.SqlServer.Dts.Tasks.DMQueryTask.SR), UITypeName="Microsoft.SqlServer.Dts.Tasks.DMQueryTaskUI.DMQueryTaskUI, Microsoft.SqlServer.DMQueryTaskUI, Version=15.0.0.0, Culture=Neutral, PublicKeyToken=89845dcd8080cc91")]
public class DMQueryTask : Microsoft.SqlServer.Dts.Runtime.Task, Microsoft.SqlServer.Dts.Runtime.IDTSBreakpointSite, Microsoft.SqlServer.Dts.Runtime.IDTSComponentPersist, Microsoft.SqlServer.Dts.Tasks.DMQueryTask.IDMQueryTask

[<System.Runtime.InteropServices.Guid("115AC6A7-F095-450F-A8DF-72A07052A146")>]
[<Microsoft.SqlServer.Dts.Runtime.DtsTask(IconResource="Microsoft.SqlServer.Dts.Tasks.DMQueryTask.Graphics.DMQueryTask.ico", LocalizationType=typeof(Microsoft.SqlServer.Dts.Tasks.DMQueryTask.SR), UITypeName="Microsoft.SqlServer.Dts.Tasks.DMQueryTaskUI.DMQueryTaskUI, Microsoft.SqlServer.DMQueryTaskUI, Version=15.0.0.0, Culture=Neutral, PublicKeyToken=89845dcd8080cc91")>]
type DMQueryTask = class
    inherit Task
    interface IDTSBreakpointSite
    interface IDTSSuspend
    interface IDTSComponentPersist
    interface IDMQueryTask

Public Class DMQueryTask
Inherits Task
Implements IDMQueryTask, IDTSBreakpointSite, IDTSComponentPersist

Inheritance

Object

DtsObject

Task

DMQueryTask

Attributes

DtsTaskAttribute GuidAttribute

Implements

IDTSBreakpointSite IDTSComponentPersist IDTSSuspend IDMQueryTask

Remarks

For more information, see Data Mining Query Task.

Constructors

DMQueryTask()

Initializes a new instance of the DMQueryTask class.

Properties

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.
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	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	Gets or sets the information about the state of the MicrosoftSQL ServerIntegration 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.
TargetServerVersion	(Inherited from Task)
Version	*** Member deprecated; see Remarks. ***   Returns the version of the task. This property is read-only. (Inherited from Task)

Methods

AcceptBreakpointManager(BreakpointManager)	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(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 task.
ExecuteQuery(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging, Object)	Executes the query found in the QueryString property.
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 properties associated with the task. This method is called by the runtime and is not used in code. (Inherited from Task)
LoadFromXML(XmlElement, IDTSInfoEvents)	This method is not callable by your application code. Loads a package saved as .xml, use the LoadPackage(String, IDTSEvents) method.
ResumeExecution()	Resumes execution of the task after pausing. The task or container is resumed by the runtime engine.
SaveToXML(XmlDocument, IDTSInfoEvents)	This method is not callable by your application code. Saves a package as .xml, use the SaveToXml(String, Package, IDTSEvents) method.
SuspendExecution()	Indicates that the executable needs to suspend. This method is called by the runtime engine.
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)	Verifies that the component is properly configured.