以编程方式加载和运行远程包

项目
05/23/2023

适用范围：SQL Server Azure 数据工厂中的 SSIS Integration Runtime

若要从未安装 Integration Services 的本地计算机运行远程包，请启动这些包，以便它们可在安装了 Integration Services 的远程计算机上运行。为此，可在本地计算机上使用 SQL Server 代理、Web 服务或远程组件来启动远程计算机上的包。如果尝试直接从本地计算机启动远程包，则这些包将加载到本地计算机上，并尝试在本地计算机上运行。如果本地计算机未安装 Integration Services，这些包将不会运行。

注意

在 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 作业在远程计算机上运行包。

注意

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 服务分配适当的权限。有关 Web、数据库和文件系统权限的全面讨论已超出了本主题的范围。

重要

Application 类中用于 SSIS 包存储的方法仅支持“.”、localhost 或本地服务器的服务器名称。不能使用“(local)”。

代码示例

下面的代码示例演示如何创建和测试 Web 服务。

创建 Web 服务

包可从文件或 SQL Server 直接加载，也可以从 SSIS 包存储区加载，该存储区在 SQL Server 和特殊文件系统文件夹中管理包存储。此示例支持所有可用选项，方法是使用 Select Case 或 switch 构造来选择启动包所用的相应语法，并相应地连接输入参数。 LaunchPackage Web 服务方法返回的包执行结果为整数形式，而不是 DTSExecResult 值，以便客户端计算机不需要引用任何 Integration Services 程序集。

以编程方式创建 Web 服务以在服务器上运行包

打开 Visual Studio，并使用首选的编程语言创建一个 Web 服务项目。示例代码将该项目命名为 LaunchSSISPackageService。
添加对 Microsoft.SqlServer.ManagedDTS 的引用，然后向 Microsoft.SqlServer.Dts.Runtime 命名空间的代码文件添加 Imports 或 using 语句。
将 LaunchPackage Web 服务方法的示例代码粘贴到类中。（该示例显示了代码窗口的全部内容。）
生成该 Web 服务，并通过为 LaunchPackage 方法的输入参数提供一组指向现有包的有效值来进行测试。例如，如果 package1.dtsx 存储在服务器的 C:\My Packages 中，则传递“file”作为 sourceType 的值，“C:\My Packages”作为 sourceLocation 的值，以及“package1”（不带扩展名）作为 packageName 的值。

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 方法返回的包执行结果为整数形式，而不是 DTSExecResult 值，以便客户端计算机不需要引用任何 Integration Services 程序集。该示例创建私有枚举，该枚举的值镜像 DTSExecResult 值，以报告执行结果。

创建用于测试 Web 服务的控制台应用程序

在 Visual Studio 中，使用首选的编程语言将新的控制台应用程序添加到包含 Web 服务项目的解决方案中。示例代码将该项目命名为 LaunchSSISPackageTest。
将新的控制台应用程序设置为解决方案中的启动项目。
添加对 Web 服务项目的 Web 引用。如有必要，可调整示例代码中分配给 Web 服务代理对象的名称的变量声明。
将主例程和私有枚举的示例代码粘贴到代码中。（该示例显示了代码窗口的全部内容。）
编辑调用 LaunchPackage 方法的代码行，为输入参数提供一组指向现有包的有效值。例如，如果 package1.dtsx 存储在服务器的 C:\My Packages 中，则传递“file”作为 sourceType 的值，“C:\My Packages”作为 sourceLocation 的值，以及“package1”（不带扩展名）作为 packageName 的值。

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 服务的控制台应用程序

外部资源

另请参阅

反馈

其他资源