ASExecuteDDLTask クラス

[アーティクル]
04/26/2013

Microsoft SQL Server Analysis Services のインスタンスに対してデータ定義言語 (DDL) コマンドを実行します。

継承階層

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

名前空間: Microsoft.DataTransformationServices.Tasks.DTSProcessingTask
アセンブリ: Microsoft.SqlServer.ASTasks (Microsoft.SqlServer.ASTasks.dll)

構文

'宣言
<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
'使用
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

ASExecuteDDLTask 型は、以下のメンバーを公開しています。

コンストラクター

	名前	説明
	ASExecuteDDLTask	ASExecuteDDLTask クラスの新しいインスタンスを作成します。

先頭に戻る

プロパティ

	名前	説明
	ConnectionName	インフラストラクチャです。Analysis Services タスクが使用する接続の名前を取得または設定します。 (ASTaskBase から継承されています。)
	ExecutionValue	Analysis Services DDL 実行タスクの結果を取得します。 (Task.ExecutionValue をオーバーライドします。)
	ProgressEventName	インフラストラクチャです。Analysis Services タスクの進行状況イベントの名前を取得します。 (ASTaskBase から継承されています。)
	Source	Analysis Services サーバーに送信される DDL ステートメントを含むソースの名前を取得します。値の設定も可能です。
	SourceType	DDL ステートメントを含むソースの種類を示す値を DDLSourceType 列挙から取得します。値の設定も可能です。
	StatusEventName	インフラストラクチャです。Analysis Services DDL 実行タスクの状態イベントの名前を取得します。 (ASTaskBase.StatusEventName をオーバーライドします。)
	SubComponentName	インフラストラクチャです。Analysis Services DDL 実行タスクのサブコンポーネントの名前を取得します。 (ASTaskBase.SubComponentName をオーバーライドします。)
	TaskDescription	Analysis Services DDL 実行タスクの説明を取得します。
	TaskDisplayName	Analysis Services DDL 実行タスクの一意の名前を取得します。
	Version	* このメンバーは非推奨です。「解説」を参照してください。 * タスクのバージョンを返します。このプロパティは読み取り専用です。 (Task から継承されています。)

先頭に戻る

メソッド

	名前	説明
	CanUpdate	* このメンバーは非推奨です。「解説」を参照してください。 * 新しいパッケージの XML で古いパッケージの XML を更新できるかどうかを示す Boolean 値。 (Task から継承されています。)
	Equals	2 つのオブジェクトインスタンスが等しいかどうかを示します。 (DtsObject から継承されています。)
	Execute	インフラストラクチャです。Analysis Services タスクを実行します。 (ASTaskBase から継承されています。)
	Finalize	(Object から継承されています。)
	FireError(String, String)	インフラストラクチャです。エラーが発生したときにイベントを発生させます。 (ASTaskBase から継承されています。)
	FireError(Int32, String, String, String)	インフラストラクチャです。エラーが発生したときにイベントを発生させます。 (ASTaskBase から継承されています。)
	GetConnectionID	接続の ID を含む String を取得します。 (Task から継承されています。)
	GetConnectionName	接続の名前を含む String を取得します。 (Task から継承されています。)
	GetHashCode	このインスタンスのハッシュコードを返します。 (DtsObject から継承されています。)
	GetType	(Object から継承されています。)
	InitializeTask	タスクに関連付けられたプロパティを初期化します。このメソッドはランタイムから呼び出されるメソッドであり、コードでは使用されません。 (Task から継承されています。)
	InternalExecute	インフラストラクチャです。DDL タスクを内部で実行します。 (ASTaskBase.InternalExecute(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging, Object) をオーバーライドします。)
	InternalValidate	インフラストラクチャです。DDL タスクを内部で検証します。 (ASTaskBase.InternalValidate(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging) をオーバーライドします。)
	LoadFromXML	このメソッドをアプリケーションコードから呼び出すことはできません。.xml として保存されたパッケージを読み込むには、Application.LoadPackage メソッドを使用します。
	MemberwiseClone	(Object から継承されています。)
	SaveToXML	このメソッドをアプリケーションコードから呼び出すことはできません。パッケージを .xml として保存するには、Application.SaveToXml メソッドを使用します。
	StopExecution	インフラストラクチャです。Analysis Services タスクの実行を停止します。 (ASTaskBase から継承されています。)
	SubscribeToProgressEvent	インフラストラクチャです。進行状況イベントにタスクをサブスクライブします。 (ASTaskBase から継承されています。)
	ToString	(Object から継承されています。)
	UnsubscribeToProgressEvent	インフラストラクチャです。進行状況イベントからタスクをアンサブスクライブします。 (ASTaskBase から継承されています。)
	Update	* このメンバーは非推奨です。「解説」を参照してください。 * CanUpdate が true に設定されている場合、このメソッドによって、古いパッケージ XML が新しいパッケージ XML で更新されます。 (Task から継承されています。)
	Validate	インフラストラクチャです。Analysis Services タスクを検証します。 (ASTaskBase から継承されています。)
	ValidateConnection	インフラストラクチャです。タスク接続を検証します。 (ASTaskBase から継承されています。)
	ValidateDDL	インフラストラクチャです。DDL タスクが正しく構成されていることを確認します。 (ASTaskBase.ValidateDDL(VariableDispenser, Connections, Exception%) をオーバーライドします。)
	WriteLog	インフラストラクチャです。タスクのログを書き込みます。 (ASTaskBase から継承されています。)

先頭に戻る

フィールド

	名前	説明
	bExecutionCanceled	インフラストラクチャです。実行が取り消されました。 (ASTaskBase から継承されています。)
	bTraceError	インフラストラクチャです。トレースエラーです。 (ASTaskBase から継承されています。)
	ddl	インフラストラクチャです。データ定義言語です。 (ASTaskBase から継承されています。)
	m_events	インフラストラクチャです。イベントです。 (ASTaskBase から継承されています。)
	server	インフラストラクチャです。サーバーです。 (ASTaskBase から継承されています。)

先頭に戻る

使用例

次のコードサンプルでは、実行する DDL ステートメントをファイル接続から読み込む新しい ASExecuteDDLTask を作成し、構成して実行します。

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

スレッドセーフ

この型の public static (Visual Basic では Shared) のメンバーはすべて、スレッドセーフです。インスタンスメンバーの場合は、スレッドセーフであるとは限りません。

次の方法で共有

ASExecuteDDLTask クラス

継承階層

構文

コンストラクター

プロパティ

メソッド

フィールド

使用例

スレッドセーフ

関連項目

参照

その他のリソース

次の方法で共有

ASExecuteDDLTask クラス

継承階層

構文

コンストラクター

プロパティ

メソッド

フィールド

使用例

スレッド セーフ

関連項目

参照

その他のリソース

スレッドセーフ