加载本地包的输出

项目
05/15/2023

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

使用 ADO.NET 将输出保存到 SQL Server 目标，或使用 System.IO 命名空间中的类将输出保存到平面文件目标时，客户端应用程序即可读取 Integration Services 包的输出。但是，客户端应用程序也可以直接从内存读取包的输出，而无需中间步骤来持久化这些数据。此解决方案的关键是 Microsoft.SqlServer.Dts.DtsClient 命名空间，该命名空间包含来自 System.Data 命名空间的 IDbConnection、IDbCommand 和 IDbDataParameter 接口的专用实现。默认情况下，程序集 Microsoft.SqlServer.Dts.DtsClient.dll 安装在 %ProgramFiles%\Microsoft SQL Server\100\DTS\Binn 中。

重要

对于本文中描述的过程，使用 DtsClient 库的过程仅适用于使用包部署模型（即使用/SQL/DTS 或 /File 选项）部署的包。此过程不适用于使用服务器部署模型（即使用 /ISServer 选项）部署的包。对于使用服务器部署模型（即使用 /ISServer 选项）部署的本地包，若要使用其输出，请使用数据流目标，而不是本文中介绍的过程。

备注

本主题介绍的过程要求数据流任务以及所有父对象的 DelayValidation 属性均设置为其默认值 False。

说明

本过程说明如何使用托管代码开发客户端应用程序，该应用程序使用 DataReader 目标直接从内存加载包的输出。此处总结的步骤在随后的代码示例中演示。

将数据包输出加载到客户端应用程序中

在包中，配置 DataReader 目标，以接收要读入到客户端应用程序中的输出。使用说明性的名称为 DataReader 目标命名，因为您稍后将在客户端应用程序中使用此名称。请记录 DataReader 目标的名称。
在开发项目中，通过查找程序集 Microsoft.SqlServer.Dts.DtsClient.dll 设置对 Microsoft.SqlServer.Dts.DtsClient 命名空间的引用。默认情况下，此程序集安装在 C:\Program Files\Microsoft SQL Server\100\DTS\Binn 中。使用 C# Using 或 Imports 语句将该命名空间导入到代码中Visual Basic 。
在代码中，创建类型为 DtsClient.DtsConnection 的对象，该对象具有一个连接字符串，其中包含 dtexec.exe 运行包时所需的命令行参数。有关详细信息，请参阅 dtexec Utility。然后，使用此连接字符串打开连接。还可以使用 dtexecui 实用工具直观地创建所需的连接字符串。

备注

该示例代码演示如何使用 /FILE <path and filename> 语法从文件系统加载包。但您也可以使用 /SQL <package name> 语法从 MSDB 数据库加载包，或者使用 /DTS \<folder name>\<package name> 语法从 Integration Services 包存储区加载包。
创建类型为 DtsClient.DtsCommand 的对象，该对象使用先前创建的 DtsConnection，并将该对象的 CommandText 属性设置为包中 DataReader 目标的名称。然后调用命令对象的 ExecuteReader 方法以将包结果加载到新的 DataReader 中。
还可以通过对 DtsCommand 对象使用 DtsDataParameter 对象的集合来间接参数化包的输出，以将值传递给在包中定义的变量。在包中，您可以使用这些变量作为查询参数或在表达式中使用这些变量以影响返回给 DataReader 目标的结果。必须先在 DtsClient 命名空间中的包中定义这些变量，然后才能将这些变量用于客户端应用程序的 DtsDataParameter 对象。（可能需要单击“变量”窗口中的“选择变量列”工具栏按钮才会显示“命名空间”列。）在客户端代码中，将 DtsDataParameter 添加到 DtsCommand 的参数集合时，可省略变量名称的 DtsClient 命名空间引用。例如：
```
command.Parameters.Add(new DtsDataParameter("MyVariable", 1));  
```
根据需要重复调用 DataReader 的 Read 方法以遍历输出数据的各行。使用这些数据，或将这些数据保存在客户端应用程序，以供将来使用。

重要

读取最后一行数据后，此 DataReader 实现的 Read 方法将再返回一次 true。因此在 Read 返回 true 时很难使用遍历 DataReader 的常规代码。如果代码在读取预期行数后尝试关闭 DataReader 或连接，而不对 Read 方法进行附加的最终调用时，该代码将引发未处理的异常。但是，如果代码尝试在此循环的最后一轮的操作中读取数据，在 Read 仍返回 true 而最后一行已传递时，该代码将引发未处理的 ApplicationException，并包含消息“SSIS IDataReader 已到达结果集末尾”。此行为与其他 DataReader 实现的行为不同。因此，使用循环读取 DataReader 中的各行，而 Read 返回 true 时，需要针对上次成功调用 Read 方法编写代码以捕获、测试和放弃此预期的 ApplicationException。或者，如果事先知道应读取的行数，则可以处理这些行，然后在关闭 DataReader 和连接之前再调用一次 Read 方法。
调用 DtsCommand 对象的 Dispose 方法。如果已使用任何 DtsDataParameter 对象，这样做尤其重要。
关闭 DataReader 和连接对象。

示例

下面的示例将运行一个包，用于计算单个聚合值并将该值保存到 DataReader 目标，然后从 DataReader 读取此值，并在 Windows 窗体的文本框中显示该值。

在将包的输出加载到客户端应用程序时不一定要使用参数。如果不希望使用参数，可在 DtsClient 命名空间中省略变量的使用，并省略使用 DtsDataParameter 对象的代码。

创建测试包

创建新的 Integration Services 包。示例代码使用“DtsClientWParamPkg.dtsx”作为包的名称。
在 DtsClient 命名空间中添加类型为 String 的变量。示例代码使用 Country 作为该变量的名称。（可能需要单击“变量”窗口中的“选择变量列”工具栏按钮才会显示“命名空间”列。）
添加用于连接 AdventureWorks2022 示例数据库的 OLE DB 连接管理器。
向包添加数据流任务，并切换到数据流设计图面。
向数据流添加 OLE DB 源，并将其配置为使用之前创建的 OLE DB 连接管理器以及下面的 SQL 命令：
```
SELECT * FROM Sales.vIndividualCustomer WHERE CountryRegionName = ?  
```
单击“参数”并在“设置查询参数”对话框中，将单个输入参数 Parameter0 映射到 DtsClient::Country 变量。
向数据流添加聚合转换，并将 OLE DB 源的输出连接到该转换。打开聚合转换编辑器，将其配置为对所有输入列 (*) 执行“COUNT ALL”运算，并以别名 CustomerCount 输出聚合值。
向数据流添加 DataReader 目标，并将聚合转换的输出连接到 DataReader 目标。示例代码使用“DataReaderDest”作为 DataReader 的名称。为目标选择单个可用输入列 CustomerCount。
保存包。接下来要创建的测试应用程序将运行该包并直接从内存检索其输出。

创建测试应用程序

创建新的 Windows 窗体应用程序。
通过浏览到 %ProgramFiles%\Microsoft SQL Server\100\DTS\Binn 中的相名程序集，添加对 Microsoft.SqlServer.Dts.DtsClient 命名空间的引用。
复制以下示例代码并将其粘贴到窗体的代码模块中。
根据需要修改 dtexecArgs 变量的值，以使该变量包含 dtexec.exe 运行包时所需的命令行参数。示例代码从文件系统加载包。
根据需要修改 dataReaderName 变量的值，以使该变量包含包中的 DataReader 目标的名称。
在窗体中放入一个按钮和一个文本框。示例代码使用 btnRun 作为按钮的名称，使用 txtResults 作为文本框的名称。
运行该应用程序并单击按钮。在短暂运行包后，您应能够看到在窗体的文本框中显示由包计算的聚合值（Canada 的客户计数）。

代码示例

Imports System.Data  
Imports Microsoft.SqlServer.Dts.DtsClient  
  
Public Class Form1  
  
  Private Sub btnRun_Click(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles btnRun.Click  
  
    Dim dtexecArgs As String  
    Dim dataReaderName As String  
    Dim countryName As String  
  
    Dim dtsConnection As DtsConnection  
    Dim dtsCommand As DtsCommand  
    Dim dtsDataReader As IDataReader  
    Dim dtsParameter As DtsDataParameter  
  
    Windows.Forms.Cursor.Current = Cursors.WaitCursor  
  
    dtexecArgs = "/FILE ""C:\...\DtsClientWParamPkg.dtsx"""  
    dataReaderName = "DataReaderDest"  
    countryName = "Canada"  
  
    dtsConnection = New DtsConnection()  
    With dtsConnection  
      .ConnectionString = dtexecArgs  
      .Open()  
    End With  
  
    dtsCommand = New DtsCommand(dtsConnection)  
    dtsCommand.CommandText = dataReaderName  
  
    dtsParameter = New DtsDataParameter("Country", DbType.String)  
    dtsParameter.Direction = ParameterDirection.Input  
    dtsCommand.Parameters.Add(dtsParameter)  
  
    dtsParameter.Value = countryName  
  
    dtsDataReader = dtsCommand.ExecuteReader(CommandBehavior.Default)  
  
    With dtsDataReader  
      .Read()  
      txtResults.Text = .GetInt32(0).ToString("N0")  
    End With  
  
    'After reaching the end of data rows,  
    ' call the Read method one more time.  
    Try  
      dtsDataReader.Read()  
    Catch ex As Exception  
      MessageBox.Show("Exception on final call to Read method:" & ControlChars.CrLf & _  
      ex.Message & ControlChars.CrLf & _  
      ex.InnerException.Message, "Exception on final call to Read method", _  
      MessageBoxButtons.OK, MessageBoxIcon.Error)  
    End Try  
  
    ' The following method is a best practice, and is  
    '  required when using DtsDataParameter objects.  
    dtsCommand.Dispose()  
  
    Try  
      dtsDataReader.Close()  
    Catch ex As Exception  
      MessageBox.Show("Exception closing DataReader:" & ControlChars.CrLf & _  
      ex.Message & ControlChars.CrLf & _  
      ex.InnerException.Message, "Exception closing DataReader", _  
      MessageBoxButtons.OK, MessageBoxIcon.Error)  
    End Try  
  
    Try  
      dtsConnection.Close()  
    Catch ex As Exception  
      MessageBox.Show("Exception closing connection:" & ControlChars.CrLf & _  
      ex.Message & ControlChars.CrLf & _  
      ex.InnerException.Message, "Exception closing connection", _  
      MessageBoxButtons.OK, MessageBoxIcon.Error)  
    End Try  
  
    Windows.Forms.Cursor.Current = Cursors.Default  
  
  End Sub  
  
End Class

using System;  
using System.Windows.Forms;  
using System.Data;  
using Microsoft.SqlServer.Dts.DtsClient;  
  
namespace DtsClientWParamCS  
{  
  public partial class Form1 : Form  
  {  
    public Form1()  
    {  
      InitializeComponent();  
      this.btnRun.Click += new System.EventHandler(this.btnRun_Click);  
    }  
  
    private void btnRun_Click(object sender, EventArgs e)  
    {  
      string dtexecArgs;  
      string dataReaderName;  
      string countryName;  
  
      DtsConnection dtsConnection;  
      DtsCommand dtsCommand;  
      IDataReader dtsDataReader;  
      DtsDataParameter dtsParameter;  
  
      Cursor.Current = Cursors.WaitCursor;  
  
      dtexecArgs = @"/FILE ""C:\...\DtsClientWParamPkg.dtsx""";  
      dataReaderName = "DataReaderDest";  
      countryName = "Canada";  
  
      dtsConnection = new DtsConnection();  
      {  
        dtsConnection.ConnectionString = dtexecArgs;  
        dtsConnection.Open();  
      }  
  
      dtsCommand = new DtsCommand(dtsConnection);  
      dtsCommand.CommandText = dataReaderName;  
  
      dtsParameter = new DtsDataParameter("Country", DbType.String);  
      dtsParameter.Direction = ParameterDirection.Input;  
      dtsCommand.Parameters.Add(dtsParameter);  
  
      dtsParameter.Value = countryName;  
  
      dtsDataReader = dtsCommand.ExecuteReader(CommandBehavior.Default);  
  
      {  
        dtsDataReader.Read();  
        txtResults.Text = dtsDataReader.GetInt32(0).ToString("N0");  
      }  
  
      //After reaching the end of data rows,  
      // call the Read method one more time.  
      try  
      {  
        dtsDataReader.Read();  
      }  
      catch (Exception ex)  
      {  
        MessageBox.Show(  
          "Exception on final call to Read method:\n" + ex.Message + "\n" + ex.InnerException.Message,  
          "Exception on final call to Read method", MessageBoxButtons.OK, MessageBoxIcon.Error);  
      }  
  
      // The following method is a best practice, and is  
      //  required when using DtsDataParameter objects.  
      dtsCommand.Dispose();  
  
      try  
      {  
        dtsDataReader.Close();  
      }  
      catch (Exception ex)  
      {  
        MessageBox.Show(  
          "Exception closing DataReader:\n" + ex.Message + "\n" + ex.InnerException.Message,  
          "Exception closing DataReader", MessageBoxButtons.OK, MessageBoxIcon.Error);  
      }  
  
      try  
      {  
        dtsConnection.Close();  
      }  
      catch (Exception ex)  
      {  
        MessageBox.Show(  
          "Exception closing connection:\n" + ex.Message + "\n" + ex.InnerException.Message,  
          "Exception closing connection", MessageBoxButtons.OK, MessageBoxIcon.Error);  
      }  
  
      Cursor.Current = Cursors.Default;  
  
    }  
  }  
}

另请参阅

了解本地和远程执行之间的区别
 以编程方式加载和运行本地包
 以编程方式加载和运行远程包

通过