プログラムによるリモートパッケージの読み込みと実行

[アーティクル]
05/23/2023

適用対象: SQL Server Azure Data Factory の SSIS 統合ランタイム

Integration Services がインストールされていないローカルコンピューターからリモートパッケージを実行するには、Integration Services がインストールされているリモートコンピューター上でパッケージが実行されるように、パッケージを起動します。この操作を行うには、ローカルコンピューターで SQL Server エージェント、Web サービス、またはリモートコンポーネントを使用して、リモートコンピューターでパッケージを起動します。ローカルコンピューターから直接リモートパッケージを起動しようとすると、パッケージがローカルコンピューターに読み込まれ、ローカルコンピューターから実行されます。ローカルコンピューターに Integration Services がインストールされていない場合、パッケージは実行されません。

Note

SQL Server Data Tools がインストールされていないクライアントコンピューターでは、パッケージを Integration Services の外部で実行することはできません。また、SQL Server ライセンスの条項により、Integration Services を他のコンピューターにインストールできない場合があります (Integration Services はサーバーコンポーネントであるため、クライアントコンピューターに再配布できません)。

また、Integration Services がインストールされているローカルコンピューターからリモートパッケージを実行することもできます。詳細については、「プログラムによるローカルパッケージの読み込みと実行」を参照してください。

リモートコンピューターでのリモートパッケージの実行

上で説明しましたが、リモートサーバーでリモートパッケージを実行する方法は複数あります。

SQL Server エージェントを使用して、プログラムでリモートパッケージを実行する
Web サービスまたはリモートコンポーネントを使用して、プログラムでリモートパッケージを実行する

このトピックでパッケージを読み込み、保存するために使用するほとんどすべてのメソッドには、Microsoft.SqlServer.ManagedDTS アセンブリへの参照が必要です。ただし、このトピックで説明する、sp_start_job ストアドプロシージャを実行するための ADO.NET の方法は例外です。この方法では、System.Data への参照のみが必要です。 Microsoft.SqlServer.ManagedDTS アセンブリへの参照を新しいプロジェクトに追加した後、using または Imports ステートメントを使用して Microsoft.SqlServer.Dts.Runtime 名前空間をインポートします。

SQL Server エージェントを使用した、サーバー上でのプログラムによるリモートパッケージの実行

次のコード例では、プログラムで SQL Server エージェントを使用して、サーバー上のリモートパッケージを実行する方法を示します。このコード例では、sp_start_job システムストアドプロシージャを呼び出し、SQL Server エージェントジョブを開始します。プロシージャによって開始されるジョブの名前は RunSSISPackage で、このジョブはリモートコンピューターに保存されています。その後、RunSSISPackage ジョブにより、リモートコンピューターでパッケージが実行されます。

Note

sp_start_job ストアドプロシージャの戻り値は、ストアドプロシージャが SQL Server エージェントのジョブを正常に開始できたかどうかを示します。この戻り値は、パッケージが成功したか失敗したかを示しません。

SQL Server エージェントのジョブから実行するパッケージのトラブルシューティングについては、Microsoft の記事「SQL Server エージェントのジョブステップから SSIS パッケージを呼び出したときに SSIS パッケージが実行されない」を参照してください。

サンプルコード

Imports System.Data  
Imports System.Data.SqlClient  
  
Module Module1  
  
  Sub Main()  
  
    Dim jobConnection As SqlConnection  
    Dim jobCommand As SqlCommand  
    Dim jobReturnValue As SqlParameter  
    Dim jobParameter As SqlParameter  
    Dim jobResult As Integer  
  
    jobConnection = New SqlConnection("Data Source=(local);Initial Catalog=msdb;Integrated Security=SSPI")  
    jobCommand = New SqlCommand("sp_start_job", jobConnection)  
    jobCommand.CommandType = CommandType.StoredProcedure  
  
    jobReturnValue = New SqlParameter("@RETURN_VALUE", SqlDbType.Int)  
    jobReturnValue.Direction = ParameterDirection.ReturnValue  
    jobCommand.Parameters.Add(jobReturnValue)  
  
    jobParameter = New SqlParameter("@job_name", SqlDbType.VarChar)  
    jobParameter.Direction = ParameterDirection.Input  
    jobCommand.Parameters.Add(jobParameter)  
    jobParameter.Value = "RunSSISPackage"  
  
    jobConnection.Open()  
    jobCommand.ExecuteNonQuery()  
    jobResult = DirectCast(jobCommand.Parameters("@RETURN_VALUE").Value, Integer)  
    jobConnection.Close()  
  
    Select Case jobResult  
      Case 0  
        Console.WriteLine("SQL Server Agent job, RunSISSPackage, started successfully.")  
      Case Else  
        Console.WriteLine("SQL Server Agent job, RunSISSPackage, failed to start.")  
    End Select  
    Console.Read()  
  
  End Sub  
  
End Module

using System;  
using System.Data;  
using System.Data.SqlClient;  
  
namespace LaunchSSISPackageAgent_CS  
{  
  class Program  
  {  
    static void Main(string[] args)  
    {  
      SqlConnection jobConnection;  
      SqlCommand jobCommand;  
      SqlParameter jobReturnValue;  
      SqlParameter jobParameter;  
      int jobResult;  
  
      jobConnection = new SqlConnection("Data Source=(local);Initial Catalog=msdb;Integrated Security=SSPI");  
      jobCommand = new SqlCommand("sp_start_job", jobConnection);  
      jobCommand.CommandType = CommandType.StoredProcedure;  
  
      jobReturnValue = new SqlParameter("@RETURN_VALUE", SqlDbType.Int);  
      jobReturnValue.Direction = ParameterDirection.ReturnValue;  
      jobCommand.Parameters.Add(jobReturnValue);  
  
      jobParameter = new SqlParameter("@job_name", SqlDbType.VarChar);  
      jobParameter.Direction = ParameterDirection.Input;  
      jobCommand.Parameters.Add(jobParameter);  
      jobParameter.Value = "RunSSISPackage";  
  
      jobConnection.Open();  
      jobCommand.ExecuteNonQuery();  
      jobResult = (Int32)jobCommand.Parameters["@RETURN_VALUE"].Value;  
      jobConnection.Close();  
  
      switch (jobResult)  
      {  
        case 0:  
          Console.WriteLine("SQL Server Agent job, RunSISSPackage, started successfully.");  
          break;  
        default:  
          Console.WriteLine("SQL Server Agent job, RunSISSPackage, failed to start.");  
          break;  
      }  
      Console.Read();  
    }  
  }  
}

Web サービスまたはリモートコンポーネントを使用した、プログラムによるリモートパッケージの実行

上記のサーバー上でプログラムによってパッケージを実行するためのソリューションでは、サーバー上にカスタムコードを用意する必要はありません。ただし、SQL Server エージェントに依存せずにパッケージを実行するソリューションが好ましいこともあります。次の例では、Integration Services パッケージをローカルで起動するためにサーバー上で作成できる Web サービスと、この Web サービスをクライアントコンピューターから呼び出すために使用できるテストアプリケーションを示します。 Web サービスではなくリモートコンポーネントを作成する場合は、同じコードロジックをほとんど変更せずにリモートコンポーネントで使用できます。ただし、リモートコンポーネントを使用する場合は、Web サービスよりも広範な設定が必要になることがあります。

重要

認証および承認が既定の設定である場合、Web サービスには一般に SQL Server またはファイルシステムにアクセスしてパッケージを読み込み、実行するための十分な権限がありません。 web.config ファイルで認証と承認の設定を構成し、必要に応じてデータベースおよびファイルシステムアクセス許可を割り当てることにより、Web サービスに適切なアクセス許可を割り当てる必要がある場合があります。 Web、データベース、およびファイルシステムの権限の詳細については、このトピックでは説明しません。

重要

SSIS パッケージストアを操作するための Application クラスのメソッドでは、"."、localhost、またはローカルサーバーのサーバー名のみがサポートされます。 "(local)" は使用できません。

サンプルコード

次のコード例では、Web サービスを作成およびテストする方法を示します。

Web サービスの作成

Integration Services パッケージは、ファイルや SQL Server から直接読み込んだり、SSIS パッケージストアから読み込んだりすることができます。SSIS パッケージストアは、SQL Server および特別なファイルシステムフォルダー内のパッケージストレージを管理します。このサンプルは、Select Case または switch コンストラクトを使用してパッケージを起動するための適切な構文を選択し、入力引数を適切に連結することで、すべての使用可能なオプションをサポートしています。 LaunchPackage Web サービスメソッドは、クライアントコンピューターで Integration Services アセンブリへの参照が不要になるように、パッケージの実行結果を DTSExecResult 値ではなく、整数として返します。

プログラムによってサーバー上でパッケージを実行するための Web サービスを作成するには

Visual Studio を開き、任意のプログラミング言語で Web サービスプロジェクトを作成します。サンプルコードでは、プロジェクトに LaunchSSISPackageService という名前を使用します。
Microsoft.SqlServer.ManagedDTS への参照を追加し、Microsoft.SqlServer.Dts.Runtime 名前空間のためにコードファイルに Imports または using ステートメントを追加します。
LaunchPackage Web サービスメソッドのサンプルコードをクラスに貼り付けます (このサンプルはコードウィンドウの内容全体を表しています)。
LaunchPackage メソッドの入力引数に既存のパッケージを指し示す一連の有効な値を指定することにより、Web サービスをビルドしてテストします。たとえば、package1.dtsx がサーバーの C:\My Packages に格納されている場合、sourceType の値として "file"、sourceLocation の値として "C:\My Packages"、packageName の値として "package1" (拡張子なし) を渡します。

Imports System.Web  
Imports System.Web.Services  
Imports System.Web.Services.Protocols  
Imports Microsoft.SqlServer.Dts.Runtime  
Imports System.IO  
  
<WebService(Namespace:="https://dtsue/")> _  
<WebServiceBinding(ConformsTo:=WsiProfiles.BasicProfile1_1)> _  
<Global.Microsoft.VisualBasic.CompilerServices.DesignerGenerated()> _  
Public Class LaunchSSISPackageService  
  Inherits System.Web.Services.WebService  
  
  ' LaunchPackage Method Parameters:  
  ' 1. sourceType: file, sql, dts  
  ' 2. sourceLocation: file system folder, (none), logical folder  
  ' 3. packageName: for file system, ".dtsx" extension is appended  
  
  <WebMethod()> _  
  Public Function LaunchPackage( _  
    ByVal sourceType As String, _  
    ByVal sourceLocation As String, _  
    ByVal packageName As String) As Integer 'DTSExecResult  
  
    Dim packagePath As String  
    Dim myPackage As Package  
    Dim integrationServices As New Application  
  
    ' Combine path and file name.  
    packagePath = Path.Combine(sourceLocation, packageName)  
  
    Select Case sourceType  
      Case "file"  
        ' Package is stored as a file.  
        ' Add extension if not present.  
        If String.IsNullOrEmpty(Path.GetExtension(packagePath)) Then  
          packagePath = String.Concat(packagePath, ".dtsx")  
        End If  
        If File.Exists(packagePath) Then  
          myPackage = integrationServices.LoadPackage(packagePath, Nothing)  
        Else  
          Throw New ApplicationException( _  
            "Invalid file location: " & packagePath)  
        End If  
      Case "sql"  
        ' Package is stored in MSDB.  
        ' Combine logical path and package name.  
        If integrationServices.ExistsOnSqlServer(packagePath, ".", String.Empty, String.Empty) Then  
          myPackage = integrationServices.LoadFromSqlServer( _  
            packageName, "(local)", String.Empty, String.Empty, Nothing)  
        Else  
          Throw New ApplicationException( _  
            "Invalid package name or location: " & packagePath)  
        End If  
      Case "dts"  
        ' Package is managed by SSIS Package Store.  
        ' Default logical paths are File System and MSDB.  
        If integrationServices.ExistsOnDtsServer(packagePath, ".") Then  
          myPackage = integrationServices.LoadFromDtsServer(packagePath, "localhost", Nothing)  
        Else  
          Throw New ApplicationException( _  
            "Invalid package name or location: " & packagePath)  
        End If  
      Case Else  
        Throw New ApplicationException( _  
          "Invalid sourceType argument: valid values are 'file', 'sql', and 'dts'.")  
    End Select  
  
    Return myPackage.Execute()  
  
  End Function  
  
End Class

using System;  
using System.Web;  
using System.Web.Services;  
using System.Web.Services.Protocols;  
using Microsoft.SqlServer.Dts.Runtime;  
using System.IO;  
  
[WebService(Namespace = "https://dtsue/")]  
[WebServiceBinding(ConformsTo = WsiProfiles.BasicProfile1_1)]  
public class LaunchSSISPackageServiceCS : System.Web.Services.WebService  
{  
  public LaunchSSISPackageServiceCS()  
  {  
    }  
  
  // LaunchPackage Method Parameters:  
  // 1. sourceType: file, sql, dts  
  // 2. sourceLocation: file system folder, (none), logical folder  
  // 3. packageName: for file system, ".dtsx" extension is appended  
  
  [WebMethod]  
  public int LaunchPackage(string sourceType, string sourceLocation, string packageName)  
  {   
  
    string packagePath;  
    Package myPackage;  
    Application integrationServices = new Application();  
  
    // Combine path and file name.  
    packagePath = Path.Combine(sourceLocation, packageName);  
  
    switch(sourceType)  
    {  
      case "file":  
        // Package is stored as a file.  
        // Add extension if not present.  
        if (String.IsNullOrEmpty(Path.GetExtension(packagePath)))  
        {  
          packagePath = String.Concat(packagePath, ".dtsx");  
        }  
        if (File.Exists(packagePath))  
        {  
          myPackage = integrationServices.LoadPackage(packagePath, null);  
        }  
        else  
        {  
          throw new ApplicationException("Invalid file location: "+packagePath);  
        }  
        break;  
      case "sql":  
        // Package is stored in MSDB.  
        // Combine logical path and package name.  
        if (integrationServices.ExistsOnSqlServer(packagePath, ".", String.Empty, String.Empty))  
        {  
          myPackage = integrationServices.LoadFromSqlServer(packageName, "(local)", String.Empty, String.Empty, null);  
        }  
        else  
        {  
          throw new ApplicationException("Invalid package name or location: "+packagePath);  
        }  
        break;  
      case "dts":  
        // Package is managed by SSIS Package Store.  
        // Default logical paths are File System and MSDB.  
        if (integrationServices.ExistsOnDtsServer(packagePath, "."))  
        {  
          myPackage = integrationServices.LoadFromDtsServer(packagePath, "localhost", null);  
        }  
        else  
        {  
          throw new ApplicationException("Invalid package name or location: "+packagePath);  
        }  
        break;  
      default:  
        throw new ApplicationException("Invalid sourceType argument: valid values are 'file', 'sql', and 'dts'.");  
    }  
  
    return (Int32)myPackage.Execute();  
  
  }  
  
}

Web サービスのテスト

次のサンプルコンソールアプリケーションでは、Web サービスを使用してパッケージを実行します。 Web サービスの LaunchPackage メソッドは、クライアントコンピューターで Integration Services アセンブリへの参照が不要になるように、パッケージの実行結果を DTSExecResult 値ではなく、整数として返します。このサンプルでは、実行結果を報告するために、DTSExecResult 値を反映する値を持つプライベート列挙を作成します。

Web サービスをテストするためのコンソールアプリケーションを作成するには

Visual Studio で任意のプログラミング言語を使用して、新しいコンソールアプリケーションを、Web サービスプロジェクトと同じソリューションに追加します。サンプルコードでは、プロジェクトに LaunchSSISPackageTest という名前を使用します。
新しいコンソールアプリケーションをソリューションのスタートアッププロジェクトとして設定します。
Web サービスプロジェクトの Web 参照を追加します。必要に応じて、Web サービスプロキシオブジェクトに割り当てた名前に合わせて、サンプルコードの変数宣言を調整します。
Main ルーチンとプライベート列挙のサンプルコードをコードに貼り付けます (このサンプルはコードウィンドウの内容全体を表しています)。
LaunchPackage メソッドを呼び出すコード行を編集し、入力引数に既存のパッケージを指し示す一連の有効な値を指定します。たとえば、package1.dtsx がサーバーの C:\My Packages に格納されている場合、sourceType の値として "file"、sourceLocation の値として "C:\My Packages"、packageName の値として "package1" (拡張子なし) を渡します。

Module LaunchSSISPackageTest  
  
  Sub Main()  
  
    Dim launchPackageService As New LaunchSSISPackageService.LaunchSSISPackageService  
    Dim packageResult As Integer  
  
    Try  
      packageResult = launchPackageService.LaunchPackage("sql", String.Empty, "SimpleTestPackage")  
    Catch ex As Exception  
      ' The type of exception returned by a Web service is:  
      '  System.Web.Services.Protocols.SoapException  
      Console.WriteLine("The following exception occurred: " & ex.Message)  
    End Try  
  
    Console.WriteLine(CType(packageResult, PackageExecutionResult).ToString)  
    Console.ReadKey()  
  
  End Sub  
  
  Private Enum PackageExecutionResult  
    PackageSucceeded  
    PackageFailed  
    PackageCompleted  
    PackageWasCancelled  
  End Enum  
  
End Module

using System;  
  
namespace LaunchSSISPackageSvcTestCS  
{  
  class Program  
  {  
    static void Main(string[] args)  
    {  
      LaunchSSISPackageServiceCS.LaunchSSISPackageServiceCS launchPackageService = new LaunchSSISPackageServiceCS.LaunchSSISPackageServiceCS();  
      int packageResult = 0;  
  
      try  
      {  
        packageResult = launchPackageService.LaunchPackage("sql", String.Empty, "SimpleTestPackage");  
      }  
      catch (Exception ex)  
      {  
        // The type of exception returned by a Web service is:  
        //  System.Web.Services.Protocols.SoapException  
        Console.WriteLine("The following exception occurred: " + ex.Message);  
      }  
  
      Console.WriteLine(((PackageExecutionResult)packageResult).ToString());  
      Console.ReadKey();  
  
    }  
  
    private enum PackageExecutionResult  
    {  
      PackageSucceeded,  
      PackageFailed,  
      PackageCompleted,  
      PackageWasCancelled  
    };  
  
  }  
}

外部リソース

technet.microsoft.com のビデオ「SQL Server エージェントを使用して SSIS パッケージ実行を自動化する方法 (SQL Server ビデオ)」

参照

ローカル実行とリモート実行の相違点について
 プログラムによるローカルパッケージの読み込みと実行
 ローカルパッケージの出力の読み込み

次の方法で共有

プログラムによるリモートパッケージの読み込みと実行

リモートコンピューターでのリモートパッケージの実行

SQL Server エージェントを使用した、サーバー上でのプログラムによるリモートパッケージの実行

サンプルコード

Web サービスまたはリモートコンポーネントを使用した、プログラムによるリモートパッケージの実行

サンプルコード

Web サービスの作成

プログラムによってサーバー上でパッケージを実行するための Web サービスを作成するには

Web サービスのテスト

Web サービスをテストするためのコンソールアプリケーションを作成するには

外部リソース

参照

フィードバック

その他のリソース

次の方法で共有

プログラムによるリモート パッケージの読み込みと実行

リモート コンピューターでのリモート パッケージの実行

SQL Server エージェントを使用した、サーバー上でのプログラムによるリモート パッケージの実行

サンプル コード

Web サービスまたはリモート コンポーネントを使用した、プログラムによるリモート パッケージの実行

サンプル コード

Web サービスの作成

プログラムによってサーバー上でパッケージを実行するための Web サービスを作成するには

Web サービスのテスト

Web サービスをテストするためのコンソール アプリケーションを作成するには

外部リソース

参照

フィードバック

その他のリソース

プログラムによるリモートパッケージの読み込みと実行

リモートコンピューターでのリモートパッケージの実行

SQL Server エージェントを使用した、サーバー上でのプログラムによるリモートパッケージの実行

サンプルコード

Web サービスまたはリモートコンポーネントを使用した、プログラムによるリモートパッケージの実行

サンプルコード

Web サービスをテストするためのコンソールアプリケーションを作成するには