ASExecuteDDLTask Class

  • Article

Executes Data Definition Language (DDL) commands against an instance of Microsoft SQL Server Analysis Services.

Inheritance Hierarchy

System.Object
  Microsoft.SqlServer.Dts.Runtime.DtsObject
    Microsoft.SqlServer.Dts.Runtime.Task
      Microsoft.DataTransformationServices.Tasks.DTSProcessingTask.ASTaskBase
        Microsoft.DataTransformationServices.Tasks.DTSProcessingTask.ASExecuteDDLTask

Namespace:  Microsoft.DataTransformationServices.Tasks.DTSProcessingTask
Assembly:  Microsoft.SqlServer.ASTasks (in Microsoft.SqlServer.ASTasks.dll)

Syntax

'Declaration
<GuidAttribute("FCA58F9B-5937-4FCF-B851-8683F7B5A98F")> _
<DtsTaskAttribute(LocalizationType := GetType(ASExecuteDDLTask), UITypeName := "Microsoft.DataTransformationServices.Tasks.DTSProcessingTaskUI.ASExecuteDDLTaskUI, Microsoft.SqlServer.ASTasksUI, Version=11.0.0.0, Culture=Neutral, PublicKeyToken=89845dcd8080cc91",  _
    IconResource := "ExecuteTaskIcon")> _
Public Class ASExecuteDDLTask _
    Inherits ASTaskBase _
    Implements IDTSComponentPersist
'Usage
Dim instance As ASExecuteDDLTask

[GuidAttribute("FCA58F9B-5937-4FCF-B851-8683F7B5A98F")]
[DtsTaskAttribute(LocalizationType = typeof(ASExecuteDDLTask), UITypeName = "Microsoft.DataTransformationServices.Tasks.DTSProcessingTaskUI.ASExecuteDDLTaskUI, Microsoft.SqlServer.ASTasksUI, Version=11.0.0.0, Culture=Neutral, PublicKeyToken=89845dcd8080cc91", 
    IconResource = "ExecuteTaskIcon")]
public class ASExecuteDDLTask : ASTaskBase, 
    IDTSComponentPersist

[GuidAttribute(L"FCA58F9B-5937-4FCF-B851-8683F7B5A98F")]
[DtsTaskAttribute(LocalizationType = typeof(ASExecuteDDLTask), UITypeName = L"Microsoft.DataTransformationServices.Tasks.DTSProcessingTaskUI.ASExecuteDDLTaskUI, Microsoft.SqlServer.ASTasksUI, Version=11.0.0.0, Culture=Neutral, PublicKeyToken=89845dcd8080cc91", 
    IconResource = L"ExecuteTaskIcon")]
public ref class ASExecuteDDLTask : public ASTaskBase, 
    IDTSComponentPersist

[<GuidAttribute("FCA58F9B-5937-4FCF-B851-8683F7B5A98F")>]
[<DtsTaskAttribute(LocalizationType = typeof(ASExecuteDDLTask), UITypeName = "Microsoft.DataTransformationServices.Tasks.DTSProcessingTaskUI.ASExecuteDDLTaskUI, Microsoft.SqlServer.ASTasksUI, Version=11.0.0.0, Culture=Neutral, PublicKeyToken=89845dcd8080cc91", 
    IconResource = "ExecuteTaskIcon")>]
type ASExecuteDDLTask =  
    class 
        inherit ASTaskBase 
        interface IDTSComponentPersist 
    end

public class ASExecuteDDLTask extends ASTaskBase implements IDTSComponentPersist

The ASExecuteDDLTask type exposes the following members.

Constructors

  Name Description
Public method ASExecuteDDLTask Creates a new instance of the ASExecuteDDLTask class.

Top

Properties

  Name Description
Public property ConnectionName Infrastructure. Gets or sets the name of the connection for the analysis services task. (Inherited from ASTaskBase.)
Public property ExecutionValue Gets the result of the Analysis Services Execute DDL task. (Overrides Task.ExecutionValue.)
Protected property ProgressEventName Infrastructure. Gets the name of the progress event for the analysis services task. (Inherited from ASTaskBase.)
Public property Source Gets or sets the name of the source that contains the DDL statement to be sent to the Analysis Services server.
Public property SourceType Gets or sets a value from the DDLSourceType enumeration indicating the source type that contains the DDL statements.
Protected property StatusEventName Infrastructure. Gets the status event name for the Analysis Services Execute DDL task. (Overrides ASTaskBase.StatusEventName.)
Protected property SubComponentName Infrastructure. Gets the sub component name for the Analysis Services Execute DDL task. (Overrides ASTaskBase.SubComponentName.)
Public propertyStatic member TaskDescription Gets a description of the Analysis Services Execute DDL task.
Public propertyStatic member TaskDisplayName Gets the unique name for the Analysis Services Execute DDL task.
Public property Version *** Member deprecated; see Remarks. ***    Returns the version of the task. This property is read-only. (Inherited from Task.)

Top

Methods

  Name Description
Public method CanUpdate *** 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 Determines whether two object instances are equal. (Inherited from DtsObject.)
Public method Execute Infrastructure. Executes the analysis services task. (Inherited from ASTaskBase.)
Protected method Finalize (Inherited from Object.)
Protected method FireError(String, String) Infrastructure. Raises an event when an error occurs. (Inherited from ASTaskBase.)
Protected method FireError(Int32, String, String, String) Infrastructure. Raises an event when an error occurs. (Inherited from ASTaskBase.)
Public method GetConnectionID Gets a String containing the ID of the connection. (Inherited from Task.)
Public method GetConnectionName 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 Initializes the properties associated with the task. This method is called by the runtime and is not used in code. (Inherited from Task.)
Protected method InternalExecute Infrastructure. Executes the DDL task internally. (Overrides ASTaskBase.InternalExecute(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging, Object).)
Protected method InternalValidate Infrastructure. Validates the DDL task internally. (Overrides ASTaskBase.InternalValidate(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging).)
Public method LoadFromXML 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 SaveToXML This method is not callable by your application code. To save a package as .xml, use the Application.SaveToXml method.
Protected method StopExecution Infrastructure. Stops the execution of the analysis service task. (Inherited from ASTaskBase.)
Protected method SubscribeToProgressEvent Infrastructure. Subscribes the task to progress event. (Inherited from ASTaskBase.)
Public method ToString (Inherited from Object.)
Protected method UnsubscribeToProgressEvent Infrastructure. Unsubscribes the task from the progress event. (Inherited from ASTaskBase.)
Public method 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.)
Public method Validate Infrastructure. Validates the analysis service task. (Inherited from ASTaskBase.)
Protected method ValidateConnection Infrastructure. Validates the task connection. (Inherited from ASTaskBase.)
Protected method ValidateDDL Infrastructure. Verifies that the DDL task is properly configured. (Overrides ASTaskBase.ValidateDDL(VariableDispenser, Connections, Exception%).)
Protected method WriteLog Infrastructure. Writes a log for the task. (Inherited from ASTaskBase.)

Top

Fields

  Name Description
Protected field bExecutionCanceled Infrastructure. The execution is cancelled. (Inherited from ASTaskBase.)
Protected field bTraceError Infrastructure. The trace error. (Inherited from ASTaskBase.)
Protected field ddl Infrastructure. The data definition language. (Inherited from ASTaskBase.)
Protected field m_events Infrastructure. The events. (Inherited from ASTaskBase.)
Protected field server Infrastructure. The server. (Inherited from ASTaskBase.)

Top

Examples

The following code sample creates, configures, and executes a new ASExecuteDDLTask that loads the DDL statement to execute from a file connection.

using Microsoft.SqlServer.Dts.Runtime;
using Microsoft.DataTransformationServices.Tasks.DTSProcessingTask;

class Module1
{

  public static void Main()
  {

    Package pkg = new Package();

    ConnectionManager asCM;
    asCM = pkg.Connections.Add("MSOLAP100");
    asCM.Name = "Analysis Services Connection Manager";
    asCM.ConnectionString = "Data Source=<servername>;" +
      "Initial Catalog=Adventure Works DW;Provider=MSOLAP;" +
      "Integrated Security=SSPI;Impersonation Level=Impersonate;";

    ConnectionManager cmdCM;
    cmdCM = pkg.Connections.Add("FILE");
    cmdCM.Name = "Command Source Connection Manager";
    cmdCM.ConnectionString = "C:\\ddltest.txt";

    Executable exe = pkg.Executables.Add("Microsoft.DataTransformationServices.Tasks.DTSProcessingTask.ASExecuteDDLTask, " +
      "Microsoft.SqlServer.ASTasks, Version=10.0.0.0, " +
      "Culture=neutral, PublicKeyToken=89845dcd8080cc91");
    TaskHost thTask = (TaskHost) exe;
    {
      thTask.Properties("ConnectionName").SetValue(thTask, "Analysis Services Connection Manager");
      thTask.Properties("SourceType").SetValue(thTask, DDLSourceType.FileConnection);
      thTask.Properties("Source").SetValue(thTask, "Command Source Connection Manager");
    }

    DTSExecResult valResults = pkg.Validate(pkg.Connections, pkg.Variables, null, null);

    if (valResults==DTSExecResult.Success)
    {
      pkg.Execute();
    }

  }

}

Imports Microsoft.SqlServer.Dts.Runtime
Imports Microsoft.DataTransformationServices.Tasks.DTSProcessingTask

Module Module1

  Sub Main()

    Dim pkg As New Package

    Dim asCM As ConnectionManager
    asCM = pkg.Connections.Add("MSOLAP100")
    asCM.Name = "Analysis Services Connection Manager"
    asCM.ConnectionString = "Data Source=<servername>;" & _
      "Initial Catalog=Adventure Works DW;Provider=MSOLAP;" & _
      "Integrated Security=SSPI;Impersonation Level=Impersonate;"

    Dim cmdCM As ConnectionManager
    cmdCM = pkg.Connections.Add("FILE")
    cmdCM.Name = "Command Source Connection Manager"
    cmdCM.ConnectionString = "C:\ddltest.txt"

    Dim exe As Executable = pkg.Executables.Add( _
      "Microsoft.DataTransformationServices.Tasks.DTSProcessingTask.ASExecuteDDLTask, " & _
      "Microsoft.SqlServer.ASTasks, Version=10.0.0.0, " & _
      "Culture=neutral, PublicKeyToken=89845dcd8080cc91")
    Dim thTask As TaskHost = CType(exe, TaskHost)
    With thTask
      .Properties("ConnectionName").SetValue(thTask, _
        "Analysis Services Connection Manager")
      .Properties("SourceType").SetValue(thTask, DDLSourceType.FileConnection)
      .Properties("Source").SetValue(thTask, "Command Source Connection Manager")
    End With

    Dim valResults As DTSExecResult = pkg.Validate( _
      pkg.Connections, pkg.Variables, Nothing, Nothing)

    If valResults = DTSExecResult.Success Then
      pkg.Execute()
    End If

  End Sub

End Module

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.

See Also

Reference

Microsoft.DataTransformationServices.Tasks.DTSProcessingTask Namespace