使用脚本组件创建目标

项目
05/23/2023

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

Integration Services 包的数据流中的目标组件用于将从上游源和转换接收的数据保存到数据源。目标组件通常通过现有连接管理器连接数据源。

有关脚本组件的概述，请参阅使用脚本组件扩展数据流。

脚本组件及其生成的基础结构代码可以大大简化自定义数据流组件的开发过程。但是，若要了解脚本组件的工作方式，通读开发自定义数据流组件部分，特别是开发自定义目标组件部分中的自定义数据流组件开发步骤很有帮助。

开始一个目标组件

向 SSIS 设计器的“数据流”选项卡添加脚本组件时，“选择脚本组件类型”对话框将打开并提示用户选择“源”、“目标”或“转换”脚本。在此对话框中选择“目标”。

然后，将转换的输出连接到 SSIS 设计器中的目标组件。出于测试目的，可以将源直接连接到目标，而不经任何转换。

在元数据设计模式下配置目标组件

选择创建目标组件的选项后，可使用“脚本转换编辑器”配置该组件。有关详细信息，请参阅在脚本组件编辑器中配置脚本组件。

若要选择脚本目标使用的脚本语言，请在“脚本转换编辑器”对话框的“脚本”页上设置 ScriptLanguage 属性。

注意

若要设置脚本组件的默认脚本语言，请使用“选项”对话框的“常规”页上的“脚本语言”选项。有关详细信息，请参阅 General Page。

数据流目标组件有一个输入，没有输出。在编写自定义脚本之前，必须在元数据设计模式下完成的一个步骤是使用“脚本转换编辑器”配置组件的输入。

添加连接管理器

目标组件通常使用现有连接管理器连接将数据流中的数据保存到的数据源。在“脚本转换编辑器” 的“连接管理器” 页中，单击“添加” 以添加适当的连接管理器。

但是，连接管理器只是一个封装和存储连接特定类型数据源所需信息的便利单元。您必须编写自己的自定义代码才能加载或保存数据，并且才有可能打开和关闭与数据源的连接。

有关如何在脚本组件中使用连接管理器的常规信息，请参阅在脚本组件中连接数据源。

有关“脚本转换编辑器”的“连接管理器”页的详细信息，请参阅脚本转换编辑器（“连接管理器”页）。

配置输入和输入列

目标组件有一个输入，没有输出。

在“脚本转换编辑器”的“输入列”页中，列列表显示数据流上游组件的输出中可用的列。选择要保存的列。

有关“脚本转换编辑器”的“输入列”页的详细信息，请参阅脚本转换编辑器（“输入列”页）。

“脚本转换编辑器”的“输入和输出”页显示单一输入，可以将其重命名。通过使用在自动生成的代码中创建的取值函数属性，在脚本中将通过输入的名称来引用输入。

有关“脚本转换编辑器”的“输入和输出”页上的详细信息，请参阅脚本转换编辑器（“输入和输出”页）。

添加变量

如果要在脚本中使用现有的变量，可以在“脚本转换编辑器”的“脚本”页上的 ReadOnlyVariables 和 ReadWriteVariables 属性字段中添加这些变量。

在属性字段中添加多个变量时，请用逗号将变量名隔开。还可以选择多个变量，方法是单击 ReadOnlyVariables 和 ReadWriteVariables 属性字段旁的省略号 (...) 按钮，然后在“选择变量”对话框中选择变量。

有关如何在脚本组件中使用变量的常规信息，请参阅在脚本组件中使用变量。

有关“脚本转换编辑器”的“脚本”页的详细信息，请参阅脚本转换编辑器（“脚本”页）。

在代码设计模式下编写目标组件脚本

为组件配置完元数据后，可以编写自定义脚本。在“脚本转换编辑器”的“脚本”页面中，单击“编辑脚本”打开 Microsoft Visual Studio Tools for Applications (VSTA) IDE，可在其中添加自定义脚本。编写脚本所使用的语言取决于为“脚本”页上的 ScriptLanguage 属性选择 Microsoft Visual Basic 还是 Microsoft Visual C# 作为脚本语言。

有关适用于使用脚本组件创建的所有组件类型的重要信息，请参阅脚本组件的编码和调试。

了解自动生成的代码

创建并配置目标组件后打开 VSTA IDE 时，可编辑的 ScriptMain 类会显示在代码编辑器中，其中有 ProcessInputRow 方法的存根。在 ScriptMain 类中可编写自定义代码，ProcessInputRow 是目标组件中最重要的方法。

如果在 VSTA 中打开“项目资源管理器” 窗口，可以看到脚本组件还生成了只读的 BufferWrapper 和 ComponentWrapper 项目项。 ScriptMain 类继承自 ComponentWrapper 项目项中的 UserComponent 类。

在运行时，数据流引擎调用 UserComponent 类中的 ProcessInput 方法，该方法替代 ScriptComponent 父类的 ProcessInput 方法。而 ProcessInput 方法遍历输入缓冲区中的所有行并为每一行调用一次 ProcessInputRow 方法。

编写自定义代码

若要完成自定义目标组件的创建，可能需要在 ScriptMain 类的以下方法中编写脚本。

重写 AcquireConnections 方法以连接到外部数据源。从连接管理器中提取连接对象或者需要的连接信息。
重写 PreExecute 方法以准备保存数据。例如，可能需要在此方法中创建和配置 SqlCommand 及其参数。
使用重写的 ProcessInputRow 方法将每个输入行复制到外部数据源。例如，对于 SQL Server 目标，可以将列值复制到 SqlCommand 的参数中，并为每一行执行一次该命令。对于平面文件目标，可以将每列的值写入 StreamWriter，用列分隔符将这些值隔开。
如果需要，重写 PostExecute 方法以断开与外部数据源的连接，并执行任何其他必需的清理操作。

示例

下面的示例演示在 ScriptMain 类中创建目标组件所需的代码。

备注

这些示例使用 AdventureWorks 示例数据库中的 Person.Address 表并在数据流中传递它的第一列和第四列，即 intAddressID 和 nvarchar(30)City 列。在本节中，在源、转换和目标示例中使用相同的数据。每个示例的其他前提条件和假设都记录在文档中。

ADO.NET 目标示例

本示例演示了使用现有 ADO.NET 连接管理器将数据流中的数据保存到 SQL Server 表中的目标组件。

如果要运行此示例代码，必须按照如下方式配置包和组件：

创建使用 SqlClient 提供程序连接 AdventureWorks 数据库的 ADO.NET 连接管理器。

通过在 AdventureWorks 数据库中运行以下 Transact-SQL 命令来创建一个目标表：

CREATE TABLE [Person].[Address2]([AddressID] [int] NOT NULL,  
    [City] [nvarchar](30) NOT NULL)

向数据流设计器图面添加新的脚本组件并将其配置为目标。
在 SSIS 设计器中将上游源或转换的输出连接到目标组件。（无需任何转换，即可将源直接连接到目标。）此输出应提供 AdventureWorks 示例数据库的 Person.Address 表中的数据，其中至少包含 AddressID 和 City 列。
打开“脚本转换编辑器” 。在“输入列”页中，选择 AddressID 和 City 输入列。
在“输入和输出”页中，用更具说明性的名称（如 MyAddressInput）重命名输入。
在“连接管理器”页中，添加或创建 ADO.NET 连接管理器，并以诸如 MyADONETConnectionManager 之类的名称命名。
在“脚本”页中，单击“编辑脚本”并输入下面的脚本。然后关闭脚本开发环境。
关闭“脚本转换编辑器”并运行该示例。

Imports System.Data.SqlClient  
...  
Public Class ScriptMain  
    Inherits UserComponent  
  
    Dim connMgr As IDTSConnectionManager100  
    Dim sqlConn As SqlConnection  
    Dim sqlCmd As SqlCommand  
    Dim sqlParam As SqlParameter  
  
    Public Overrides Sub AcquireConnections(ByVal Transaction As Object)  
  
        connMgr = Me.Connections.MyADONETConnectionManager  
        sqlConn = CType(connMgr.AcquireConnection(Nothing), SqlConnection)  
  
    End Sub  
  
    Public Overrides Sub PreExecute()  
  
        sqlCmd = New SqlCommand("INSERT INTO Person.Address2(AddressID, City) " & _  
            "VALUES(@addressid, @city)", sqlConn)  
        sqlParam = New SqlParameter("@addressid", SqlDbType.Int)  
        sqlCmd.Parameters.Add(sqlParam)  
        sqlParam = New SqlParameter("@city", SqlDbType.NVarChar, 30)  
        sqlCmd.Parameters.Add(sqlParam)  
  
    End Sub  
  
    Public Overrides Sub MyAddressInput_ProcessInputRow(ByVal Row As MyAddressInputBuffer)  
        With sqlCmd  
            .Parameters("@addressid").Value = Row.AddressID  
            .Parameters("@city").Value = Row.City  
            .ExecuteNonQuery()  
        End With  
    End Sub  
  
    Public Overrides Sub ReleaseConnections()  
  
        connMgr.ReleaseConnection(sqlConn)  
  
    End Sub  
  
End Class

using System.Data.SqlClient;  
public class ScriptMain:  
    UserComponent  
  
{  
    IDTSConnectionManager100 connMgr;  
    SqlConnection sqlConn;  
    SqlCommand sqlCmd;  
    SqlParameter sqlParam;  
  
    public override void AcquireConnections(object Transaction)  
    {  
  
        connMgr = this.Connections.MyADONETConnectionManager;  
        sqlConn = (SqlConnection)connMgr.AcquireConnection(null);  
  
    }  
  
    public override void PreExecute()  
    {  
  
        sqlCmd = new SqlCommand("INSERT INTO Person.Address2(AddressID, City) " +  
            "VALUES(@addressid, @city)", sqlConn);  
        sqlParam = new SqlParameter("@addressid", SqlDbType.Int);  
        sqlCmd.Parameters.Add(sqlParam);  
        sqlParam = new SqlParameter("@city", SqlDbType.NVarChar, 30);  
        sqlCmd.Parameters.Add(sqlParam);  
  
    }  
  
    public override void MyAddressInput_ProcessInputRow(MyAddressInputBuffer Row)  
    {  
        {  
            sqlCmd.Parameters["@addressid"].Value = Row.AddressID;  
            sqlCmd.Parameters["@city"].Value = Row.City;  
            sqlCmd.ExecuteNonQuery();  
        }  
    }  
  
    public override void ReleaseConnections()  
    {  
  
        connMgr.ReleaseConnection(sqlConn);  
  
    }  
  
}

平面文件目标示例

本示例演示了使用现有平面文件连接管理器将数据流中的数据保存到平面文件中的目标组件。