Any suggestions? Export (0) Print
Expand All

DMQueryTask 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.

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

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

[GuidAttribute("115AC6A7-F095-450F-A8DF-72A07052A146")]
public class DMQueryTask : Task, IDTSBreakpointSite, IDTSSuspend, 
	IDTSComponentPersist, IDMQueryTask

NameDescription
System_CAPS_pubmethodDMQueryTask()

Initializes a new instance of the DMQueryTask class.

NameDescription
System_CAPS_pubpropertyDebugMode

Gets or sets the Boolean value that indicates if a task should check if breakpoints are enabled.

System_CAPS_pubpropertyExecutionValue

Gets a user-defined object. This field is read-only.(Overrides Task.ExecutionValue.)

System_CAPS_pubpropertyInputConnection

Gets or sets the connection string to an Analysis Services project or an Analysis Services database.

System_CAPS_pubpropertyInputParameters

Gets or sets a collection of variables that is used in a parameterized Data Mining Extensions (DMX) query.

System_CAPS_pubpropertyModelName

Gets or sets the name of the mining model on which the query is based.

System_CAPS_pubpropertyModelStructureName

Gets or sets the name of the mining structure on which the query is based.

System_CAPS_pubpropertyOutputConnection

Gets or sets the connection string to the OLE DB data source where the prediction query result will be stored.

System_CAPS_pubpropertyOutputTableName

Gets or sets the name of the table where the results of the prediction query are written.

System_CAPS_pubpropertyOverwriteOutputTable

Gets or sets the Boolean value that indicates if the prediction query should overwrite content in the destination table.

System_CAPS_pubpropertyQueryBuilderQueryString

This API supports the product infrastructure and is not intended to be used directly from your code. 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.

System_CAPS_pubpropertyQueryBuilderSpecification

This API supports the product infrastructure and is not intended to be used directly from your code. 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.

System_CAPS_pubpropertyQueryString

Gets or sets a String that contains the text that the transformation uses to create a prediction query.

System_CAPS_pubpropertyResultParameters

Gets or sets a collection of Integration Services variables that is used to store the DMX query results.

System_CAPS_pubpropertySuspendRequired

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.

System_CAPS_pubpropertyVersion

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

NameDescription
System_CAPS_pubmethodAcceptBreakpointManager(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.

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_pubmethodExecuteQuery(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging, Object)

Executes the query found in the QueryString property.

System_CAPS_protmethodFinalize()

(Inherited from 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)

Initializes the properties associated with the task. This method is called by the runtime and is not used in code.(Inherited from Task.)

System_CAPS_pubmethodLoadFromXML(XmlElement, IDTSInfoEvents)

This method is not callable by your application code. Loads a package saved as .xml, use the Application.LoadPackage method.

System_CAPS_protmethodMemberwiseClone()

(Inherited from Object.)

System_CAPS_pubmethodResumeExecution()

Resumes execution of the task after pausing. The task or container is resumed by the runtime engine.

System_CAPS_pubmethodSaveToXML(XmlDocument, IDTSInfoEvents)

This method is not callable by your application code. Saves a package as .xml, use the Application.SaveToXml method.

System_CAPS_pubmethodSuspendExecution()

Indicates that the executable needs to suspend. This method is called by the runtime engine.

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)

Verifies that the component is properly configured.(Overrides Task.Validate(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging).)

For more information, see Data Mining Query Task.

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:
© 2016 Microsoft