ASExecuteDDLTask Class

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("FC95DF06-8E20-4f90-BFD5-B48AFA59C158")> _
<DtsTaskAttribute(LocalizationType := GetType(ASExecuteDDLTask), UITypeName := "Microsoft.DataTransformationServices.Tasks.DTSProcessingTaskUI.ASExecuteDDLTaskUI, Microsoft.SqlServer.ASTasksUI, Version=10.0.0.0, Culture=Neutral, PublicKeyToken=89845dcd8080cc91",  _
    IconResource := "ExecuteTaskIcon")> _
Public Class ASExecuteDDLTask _
    Inherits ASTaskBase _
    Implements IDTSComponentPersist
'Usage
Dim instance As ASExecuteDDLTask

[GuidAttribute("FC95DF06-8E20-4f90-BFD5-B48AFA59C158")]
[DtsTaskAttribute(LocalizationType = typeof(ASExecuteDDLTask), UITypeName = "Microsoft.DataTransformationServices.Tasks.DTSProcessingTaskUI.ASExecuteDDLTaskUI, Microsoft.SqlServer.ASTasksUI, Version=10.0.0.0, Culture=Neutral, PublicKeyToken=89845dcd8080cc91", 
    IconResource = "ExecuteTaskIcon")]
public class ASExecuteDDLTask : ASTaskBase, 
    IDTSComponentPersist

[GuidAttribute(L"FC95DF06-8E20-4f90-BFD5-B48AFA59C158")]
[DtsTaskAttribute(LocalizationType = typeof(ASExecuteDDLTask), UITypeName = L"Microsoft.DataTransformationServices.Tasks.DTSProcessingTaskUI.ASExecuteDDLTaskUI, Microsoft.SqlServer.ASTasksUI, Version=10.0.0.0, Culture=Neutral, PublicKeyToken=89845dcd8080cc91", 
    IconResource = L"ExecuteTaskIcon")]
public ref class ASExecuteDDLTask : public ASTaskBase, 
    IDTSComponentPersist

[<GuidAttribute("FC95DF06-8E20-4f90-BFD5-B48AFA59C158")>]
[<DtsTaskAttribute(LocalizationType = typeof(ASExecuteDDLTask), UITypeName = "Microsoft.DataTransformationServices.Tasks.DTSProcessingTaskUI.ASExecuteDDLTaskUI, Microsoft.SqlServer.ASTasksUI, Version=10.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
	ASExecuteDDLTask	Initializes a new instance of the ASExecuteDDLTask class.

Top

Properties

	Name	Description
	ConnectionName	Infrastructure. (Inherited from ASTaskBase.)
	ExecutionValue	Returns the result of the task execution. (Overrides Task.ExecutionValue.)
	ProgressEventName	Infrastructure. (Inherited from ASTaskBase.)
	Source	Gets or sets the text of the DDL statement to be sent to the Analysis Services server.
	SourceType	Gets or sets a value from the DDLSourceType enumeration indicating the source type that contains the DDL statements.
	StatusEventName	Infrastructure. (Overrides ASTaskBase.StatusEventName.)
	SubComponentName	Infrastructure. (Overrides ASTaskBase.SubComponentName.)
	TaskDescription	Returns a description of the Analysis Services Execute DDL task.
	TaskDisplayName	Returns the name of the Execute DDL task.
	Version	*** Member deprecated; see Remarks. ***    Returns the version of the task. This property is read-only. (Inherited from Task.)

Top

Methods

	Name	Description
	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	Infrastructure. (Inherited from ASTaskBase.)
	Finalize	(Inherited from Object.)
	FireError(String, String)	Infrastructure. (Inherited from ASTaskBase.)
	FireError(Int32, String, String, String)	Infrastructure. (Inherited from ASTaskBase.)
	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.)
	InternalExecute	Infrastructure. (Overrides ASTaskBase.InternalExecute(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging, Object).)
	InternalValidate	Infrastructure. (Overrides ASTaskBase.InternalValidate(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging).)
	LoadFromXML	This method is not callable by your application code. To load a package saved as .xml, use the Application.LoadPackage method.
	MemberwiseClone	(Inherited from Object.)
	SaveToXML	This method is not callable by your application code. To save a package as .xml, use the Application.SaveToXml method.
	StopExecution	Infrastructure. (Inherited from ASTaskBase.)
	SubscribeToProgressEvent	Infrastructure. (Inherited from ASTaskBase.)
	ToString	(Inherited from Object.)
	UnsubscribeToProgressEvent	Infrastructure. (Inherited from ASTaskBase.)
	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	Infrastructure. (Inherited from ASTaskBase.)
	ValidateConnection	Infrastructure. (Inherited from ASTaskBase.)
	ValidateDDL	Infrastructure. (Overrides ASTaskBase.ValidateDDL(VariableDispenser, Connections, Exception%).)
	WriteLog	Infrastructure. (Inherited from ASTaskBase.)

Top

Fields

	Name	Description
	bExecutionCanceled	Infrastructure. (Inherited from ASTaskBase.)
	bTraceError	Infrastructure. (Inherited from ASTaskBase.)
	ddl	Infrastructure. (Inherited from ASTaskBase.)
	m_events	Infrastructure. (Inherited from ASTaskBase.)
	server	Infrastructure. (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