了解指令碼元件物件模型

發行項
05/04/2023

適用於：SQL Server Azure Data Factory 中的 SSIS Integration Runtime

如同指令碼元件的程式碼撰寫和偵錯中所討論，指令碼元件專案包含了三個專案項目：

ScriptMain 項目，其中包含您用來撰寫程式碼的 ScriptMain 類別。 ScriptMain 類別繼承自 UserComponent 類別。
包含 UserComponent 類別的 ComponentWrapper 項目，該類別是 ScriptComponent 的執行個體 (其中包含您將用來處理資料以及與套件互動的方法和屬性)。 ComponentWrapper 項目也包含 Connections 和 Variables集合類別。
包含類別的 BufferWrapper 項目，該類別繼承自每一個輸入和輸出的 ScriptBuffer 及每一個資料行的具類型屬性。

當您在 ScriptMain 項目中撰寫程式碼時，您將會使用本主題討論的物件、方法和屬性。並非這裡列出的所有方法都會讓每一個元件使用，但是在使用這些方法時，則會以顯示的順序來使用。

ScriptComponent 基底類別不包含本主題討論之方法的任何實作程式碼。因此，將基底類別實作的呼叫加入到您自己的方法實作中是不必要的，但是這樣做也無害。

如需如何在特定的指令碼元件類型中使用這些類別的方法和屬性的資訊，請參閱其他指令碼元件範例。範例主題也包含完整的程式碼範例。

AcquireConnections 方法

來源和目的地通常必須連接到外部資料來源。覆寫 AcquireConnections 基底類別的 ScriptComponent 方法，從適當的連接管理員擷取連接或連接資訊。

下列範例會從 ADO.NET 連線管理員傳回 System.Data.SqlClient.SqlConnection。

Dim connMgr As IDTSConnectionManager100  
Dim sqlConn As SqlConnection  
  
Public Overrides Sub AcquireConnections(ByVal Transaction As Object)  
  
    connMgr = Me.Connections.MyADONETConnection  
    sqlConn = CType(connMgr.AcquireConnection(Nothing), SqlConnection)  
  
End Sub

下列範例會從一般檔案連線管理員傳回完整的路徑和檔案名稱，然後使用 System.IO.StreamReader 開啟檔案。

Private textReader As StreamReader  
Public Overrides Sub AcquireConnections(ByVal Transaction As Object)  
  
    Dim connMgr As IDTSConnectionManager100 = _  
        Me.Connections.MyFlatFileSrcConnectionManager  
    Dim exportedAddressFile As String = _  
        CType(connMgr.AcquireConnection(Nothing), String)  
    textReader = New StreamReader(exportedAddressFile)  
  
End Sub

PreExecute 方法

每當您的處理必須只能在您開始處理資料列以前執行一次時，請覆寫 PreExecute 基底類別的 ScriptComponent 方法。例如在目的地中，您可能會想要設定參數化命令，目的地將會使用該命令將每個資料列插入資料來源中。

    Dim sqlConn As SqlConnection  
    Dim sqlCmd As SqlCommand  
    Dim sqlParam As SqlParameter  
...  
    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

SqlConnection sqlConn;   
SqlCommand sqlCmd;   
SqlParameter sqlParam;   
  
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);   
  
}

處理輸入和輸出

處理輸入

設定為轉換或目的地的指令碼元件有一個輸入。

BufferWrapper 專案項目提供的內容

如果是您已設定的每一個輸入，BufferWrapper 專案項目都會包含一個衍生自 ScriptBuffer 的類別，而且名稱與輸入相同。每一個輸入緩衝區類別都包含下列屬性、函數和方法：

每一個選定輸入資料行的具名、具類型存取子屬性。這些屬性是唯讀或可讀寫，這取決於在 [指令碼轉換編輯器] 的 [輸入資料行] 頁面上針對資料行所指定的 [使用類型] 。
每一個選定輸入資料行的 <column>_IsNull 屬性。這個屬性也是唯讀或可讀寫，這取決於針對資料行指定的 [使用類型] 而定。
每個已設定輸出的 DirectRowTo<outputbuffer> 方法。當您在相同的 ExclusionGroup 中將資料列篩選成數個輸出的其中一個時，您將會使用這些方法。
取得下一個輸入資料列的 NextRow 函數，以及判斷上一個資料緩衝區是否已經處理的 EndOfRowset 函數。當您使用 UserComponent 基底類別內所實作的輸入處理方法時，通常不需要這些函數。下一節會提供有關 UserComponent 基底類別的詳細資訊。

ComponentWrapper 專案項目提供的內容

ComponentWrapper 專案項目包含了衍生自 ScriptComponent 的 UserComponent 類別。接著您撰寫自訂程式碼所使用的 ScriptMain 類別就會衍生自 UserComponent。 UserComponent 類別包含以下的方法：

已覆寫的 ProcessInput 方法實作。這是資料流程引擎在執行階段的 PreExecute 方法之後所呼叫的方法，而且它可呼叫多次。 ProcessInput 將處理交給 <inputbuffer>_ProcessInput 方法。然後 ProcessInput 方法會檢查輸入緩衝區的結尾，如果到達了緩衝區結尾，會呼叫可覆寫的 FinishOutputs 方法和私用 MarkOutputsAsFinished 方法。 MarkOutputsAsFinished 方法會接著呼叫最後一個輸出緩衝區上的 SetEndOfRowset。
可覆寫的 <inputbuffer>_ProcessInput 方法實作。這個預設實作只會在每一個輸入資料列中執行迴圈，並呼叫 <inputbuffer>_ProcessInputRow。
可覆寫的 <inputbuffer>_ProcessInputRow 方法實作。預設的實作是空的。這是您通常會覆寫，以撰寫自訂資料處理程式碼的方法。

自訂程式碼應該做的事

您可以使用下列方法，在 ScriptMain 類別中處理輸入：

覆寫 <inputbuffer>_ProcessInputRow，以處理每一個輸入資料列中通過的資料。
只有當您在輸入資料列中執行迴圈時，必須做其他額外動作的時候，才會覆寫 <inputbuffer>_ProcessInput。 (例如，您必須測試 EndOfRowset，在處理完所有資料列以後採取某個其他動作。) 請呼叫 <inputbuffer>_ProcessInputRow 來執行資料列處理。
如果您必須在關閉輸出以前先對輸出做某些事，請覆寫 FinishOutputs。

ProcessInput 方法可確保這些方法會在適當的時間呼叫。

處理輸出

設定為來源或轉換的指令碼元件有一個或多個輸出。

BufferWrapper 專案項目提供的內容

如果是您已設定的每一個輸出，BufferWrapper 專案項目都會包含一個衍生自 ScriptBuffer 的類別，而且名稱與輸出相同。每一個輸入緩衝區類別都包含下列屬性和方法：

每一個輸出資料行的具名、具類型、唯寫的存取子屬性。
每一個選定輸出資料行的唯寫 <column>_IsNull 屬性，您可以用來將資料行值設定為 null。
要將空白的新資料列新增至輸出緩衝區的 AddRow 方法。
可讓資料流程引擎知道不會預期其他資料緩衝區的 SetEndOfRowset 方法。也有一個 EndOfRowset 函數可判斷目前的緩衝區是否為最後一個資料緩衝區。當您使用 UserComponent 基底類別內所實作的輸入處理方法時，通常不需要這些函數。

ComponentWrapper 專案項目提供的內容

已覆寫的 PrimeOutput 方法實作。資料流程引擎會在執行階段的 ProcessInput 之前呼叫這個方法，而且只會呼叫一次。 PrimeOutput 將處理交給 CreateNewOutputRows 方法。然後，如果此元件是來源 (也就是此元件沒有輸入)，PrimeOutput 會呼叫可覆寫的 FinishOutputs 方法和私用 MarkOutputsAsFinished 方法。 MarkOutputsAsFinished 方法會呼叫最後一個輸出緩衝區上的 SetEndOfRowset。
可覆寫的 CreateNewOutputRows 方法實作。預設的實作是空的。這是您通常會覆寫，以撰寫自訂資料處理程式碼的方法。

自訂程式碼應該做的事

您可以使用下列方法，在 ScriptMain 類別中處理輸出：

只有當您在處理輸入資料列以前可以新增及擴展輸出資料列時，才會覆寫 CreateNewOutputRows。例如，您可以在來源中使用 CreateNewOutputRows，但如果是具有非同步輸出的轉換，您應該在處理輸入資料的期間或之後呼叫 AddRow。
如果您必須在關閉輸出以前先對輸出做某些事，請覆寫 FinishOutputs。

PrimeOutput 方法可確保這些方法會在適當的時間呼叫。

PostExecute 方法

每當您的處理必須只能在處理資料列之後執行一次時，請覆寫 PostExecute 基底類別的 ScriptComponent 方法。例如在來源中，您可能會想要關閉已用來將資料載入資料流程中的 System.Data.SqlClient.SqlDataReader。

重要

ReadWriteVariables 的集合僅適用於 PostExecute 方法。因此您無法在處理每一列資料時，直接增量封裝變數值。請改為遞增區域變數值，並在處理所有的資料之後，將套件變數值設定為 PostExecute 方法中的區域變數值。

ReleaseConnections 方法

來源和目的地通常必須連接到外部資料來源。覆寫 ReleaseConnections 基底類別的 ScriptComponent 方法，以關閉及釋放您之前在 AcquireConnections 方法中所開啟的連接。

    Dim connMgr As IDTSConnectionManager100  
...  
    Public Overrides Sub ReleaseConnections()  
  
        connMgr.ReleaseConnection(sqlConn)  
  
    End Sub

IDTSConnectionManager100 connMgr;  
  
public override void ReleaseConnections()  
{  
  
    connMgr.ReleaseConnection(sqlConn);  
  
}

另請參閱

在指令碼元件編輯器中設定指令碼元件
 編碼和偵錯指令碼元件

共用方式為

了解指令碼元件物件模型

AcquireConnections 方法

PreExecute 方法

處理輸入和輸出

處理輸入

BufferWrapper 專案項目提供的內容

ComponentWrapper 專案項目提供的內容

自訂程式碼應該做的事

處理輸出

BufferWrapper 專案項目提供的內容

ComponentWrapper 專案項目提供的內容

自訂程式碼應該做的事

PostExecute 方法

ReleaseConnections 方法

另請參閱

意見反應

其他資源