• Article

DMQueryTask Members

Include Protected Members
Include Inherited Members

This class 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.

The DMQueryTask type exposes the following members.

Constructors

  Name Description
Public method DMQueryTask() Initializes a new instance of the DMQueryTask class.

Top

Methods

  Name Description
Public method 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.
Public method CanUpdate(String) *** Member deprecated; see Remarks. ***    A Boolean that indicates whether the new package XML can update the old package XML. (Inherited from Task.)
Public method Equals(Object) Determines whether two object instances are equal. (Inherited from DtsObject.)
Public method Execute(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging, Object) Runs the task. (Overrides Task.Execute(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging, Object).)
Public method ExecuteQuery(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging, Object) Executes the query found in the QueryString property.
Protected method Finalize() (Inherited from Object.)
Public method GetConnectionID(Connections, String) Gets a String containing the ID of the connection. (Inherited from Task.)
Public method GetConnectionName(Connections, String) Gets a String containing the name of the connection. (Inherited from Task.)
Public method GetHashCode() Returns the hash code for this instance. (Inherited from DtsObject.)
Public method GetType() (Inherited from Object.)
Public method 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.)
Public method LoadFromXML(XmlElement, IDTSInfoEvents) This method is not callable by your application code. To load a package saved as .xml, use the Application.LoadPackage method.
Protected method MemberwiseClone() (Inherited from Object.)
Public method ResumeExecution() Resumes execution of the task after pausing. The task or container is resumed by the runtime engine.
Public method SaveToXML(XmlDocument, IDTSInfoEvents) This method is not callable by your application code. To save a package as .xml, use the Application.SaveToXml method.
Public method SuspendExecution() Indicates that the executable needs to suspend. This method is called by the runtime engine.
Public method ToString() (Inherited from Object.)
Public method Update(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.)
Public method Validate(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging) Verifies that the component is properly configured. (Overrides Task.Validate(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging).)

Top

Properties

  Name Description
Public property DebugMode A Boolean that indicates if a task should check if breakpoints are enabled.
Public property ExecutionValue Returns a user-defined object. This field is read-only. (Overrides Task.ExecutionValue.)
Public property InputConnection Gets or sets the connection string to an Analysis Services project or an Analysis Services database.
Public property InputParameters Gets or sets a collection of variables that is used in a parameterized Data Mining Extensions (DMX) query.
Public property ModelName Gets or sets the name of the mining model on which the query is based.
Public property ModelStructureName Gets or sets the name of the mining structure on which the query is based.
Public property OutputConnection Gets or sets the connection string to the OLE DB data source where the prediction query result will be stored.
Public property OutputTableName Gets or sets the name of the table where the results of the prediction query are written.
Public property OverwriteOutputTable Gets or sets the Boolean value that indicates if the prediction query should overwrite content in the destination table.
Public property QueryBuilderQueryString Infrastructure.
Public property QueryBuilderSpecification Infrastructure.
Public property QueryString Gets or sets a String that contains the text that the transformation uses to create a prediction query.
Public property ResultParameters Gets or sets a collection of Integration Services variables that is used to store the DMX query results.
Public property SuspendRequired Gets or sets a Boolean 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.
Public property Version *** Member deprecated; see Remarks. ***    Returns the version of the task. This property is read-only. (Inherited from Task.)

Top