[アーティクル]
04/01/2012

スクリプトコンポーネントによる同期変換の作成

Integration Services パッケージのデータフロー内で変換コンポーネントを使用することにより、変換元から変換先にデータが受け渡される過程で、データを修正または分析できます。同期出力型の変換では、各入力列はコンポーネントを通過するたびに処理されます。非同期出力型の変換では、処理を完了するための入力列をすべて受け取ってから、処理が行われます。このトピックでは、同期変換について説明します。非同期変換の詳細については、「スクリプトコンポーネントによる非同期変換の作成」を参照してください。同期コンポーネントと非同期コンポーネントの相違点の詳細については、「同期および非同期変換について」を参照してください。

スクリプトコンポーネントの概要については、「スクリプトコンポーネントによるデータフローの拡張」を参照してください。

スクリプトコンポーネントおよびそれによって生成されるインフラストラクチャコードを活用すれば、カスタムデータフローコンポーネントを開発するための手順を大幅に簡略化できます。ただし、スクリプトコンポーネントの動作のしくみを理解するため、「カスタムデータフローコンポーネントの開発」のセクション、特に「同期出力型のカスタム変換コンポーネントの開発」を参照して、カスタムデータフローコンポーネントの開発手順に目を通しておくと役に立ちます。

同期変換コンポーネントの概要

SSIS デザイナーの [データフロー] ペインにスクリプトコンポーネントを追加すると、[スクリプトコンポーネントの種類を選択] ダイアログボックスが開き、[変換元]、[変換先]、[変換] コンポーネントの種類のいずれかを選択するように求められます。このダイアログボックスで、[変換] を選択します。

メタデータデザインモードでの同期変換コンポーネントの構成

変換コンポーネントを作成するオプションを選択したら、[スクリプト変換エディター] を使用して、コンポーネントを構成します。詳細については、「スクリプトコンポーネントエディターでのスクリプトコンポーネントの構成」を参照してください。

スクリプトコンポーネントのスクリプト言語を設定するには、[スクリプト変換エディター] の [スクリプト] ページにある [ScriptLanguage] プロパティを設定します。

注
スクリプトコンポーネントの既定のスクリプト言語を設定するには、[オプション] ダイアログボックスの [全般] ページにある [スクリプト言語] オプションを使用します。詳細については、「[全般] ページ」を参照してください。

データフロー変換コンポーネントには 1 つの入力があり、1 つ以上の出力を設定できます。コンポーネントの入力および出力の設定は、メタデータデザインモードでカスタムスクリプトを記述する前に完了する必要のある作業の 1 つです。これを行うには、[スクリプト変換エディター] を使用します。

入力列の設定

変換コンポーネントには 1 つの入力があります。

[スクリプト変換エディター] の [入力列] ページには、データフローの上流コンポーネントの出力で使用できる列が一覧表示されます。変換する列、またはそのまま出力する列を選択します。変換するすべての列の適切な場所に、読み取り/書き込みのマークを付けます。

[スクリプト変換エディター] の [入力列] ページの詳細については、「[スクリプト変換エディタ] ([入力列] ページ)」を参照してください。

入力、出力、および出力列の設定

変換コンポーネントには、1 つ以上の出力を設定できます。

[スクリプト変換エディター] の [入力および出力] ページには、1 つの出力が作成されていますが、出力列は作成されていません。エディターのこのページで、必要に応じて以下の項目を設定します。

予期しない値を含む行に対するシミュレートされたエラー出力など、1 つ以上の出力を追加して作成する場合は、[出力の追加] および [出力の削除] ボタンを使用して、同期変換コンポーネントの出力を管理します。すべての入力行は、使用できるすべての出力に送信されます。ただし、各行を出力のうちいずれか 1 つにリダイレクトするように指定した場合を除きます。行をリダイレクトするように指定するには、出力の ExclusionGroup プロパティに 0 以外の整数値を指定します。出力を識別するために ExclusionGroup に入力した整数値に特別の意味はありませんが、指定した出力のグループでは一貫して同じ整数を使用する必要があります。

注
すべての行を出力しない場合は、0 以外の ExclusionGroup プロパティ値を単一の出力で使用することもできます。ただし、この場合は、出力に送信する各行について、DirectRowTo<outputbuffer> メソッドを明示的に呼び出す必要があります。

入力および出力に、わかりやすい名前を割り当てます。スクリプトコンポーネントはこの名前を使用して、型指定されたアクセサープロパティを生成します。これは、スクリプト内で入力や出力を参照するために使用できます。
同期変換の列は現状のままにしておきます。通常、同期変換はデータフローに列を追加しません。データはバッファーの所定の位置で変更され、バッファーがデータフロー内の次のコンポーネントに渡されます。このような場合、変換の出力に対して明示的に出力列を追加したり構成する必要はありません。出力がエディターに表示される際、明示的に定義された列は含まれません。
行レベルのエラー用のシミュレートされたエラー出力に新しい列を追加します。通常、同じ ExclusionGroup 内の複数の出力には、同じ出力列のセットが含まれます。ただし、シミュレートされたエラー出力を作成するには、エラー情報を格納するために列の追加が必要となる場合があります。データフローエンジンがエラー行を処理する方法については、「データフローコンポーネントでのエラー出力の使用」を参照してください。スクリプトコンポーネントでは、独自のコードを記述して、追加した列に該当するエラー情報を格納する必要があるので注意してください。詳細については、「スクリプトコンポーネントに対するエラー出力のシミュレート」を参照してください。

[スクリプト変換エディター] の [入力および出力] ページの詳細については、「[スクリプト変換エディタ] ([入力および出力] ページ)」を参照してください。

変数の追加

既存の変数の値をスクリプト内で使用する場合、[スクリプト変換エディター] の [スクリプト] ページで、ReadOnlyVariables プロパティおよび ReadWriteVariables プロパティのフィールドに追加できます。

プロパティフィールドに複数の変数を追加する場合は、各変数名をコンマで区切ります。また、ReadOnlyVariables プロパティフィールドや ReadWriteVariables プロパティフィールドの横にある参照ボタン ([...]) をクリックして [変数の選択] ダイアログボックスを開き、複数の変数を選択することもできます。

スクリプトコンポーネントで変数を使用する方法に関する一般情報については、「スクリプトコンポーネントでの変数の使用」を参照してください。

[スクリプト変換エディター] の [スクリプト] ページの詳細については、「[スクリプト変換エディタ] ([スクリプト] ページ)」を参照してください。

コードデザインモードでの同期変換コンポーネントのスクリプト作成

コンポーネントのメタデータを構成した後、カスタムスクリプトを記述できます。[スクリプト変換エディター] の [スクリプト] ページで [スクリプトの編集] をクリックし、Microsoft Visual Studio Tools for Applications (VSTA) IDE を開いて、カスタムスクリプトを追加できます。使用するスクリプト言語は、[スクリプト] ページの [ScriptLanguage] プロパティで、Microsoft Visual Basic 2008 と Microsoft Visual C# 2008 のどちらをスクリプト言語として選択したかによって決まります。

スクリプトコンポーネントを使用して作成するすべての種類のコンポーネントに関する重要情報については、「スクリプトコンポーネントのコーディングおよびデバッグ」を参照してください。

自動生成されたコードについて

変換コンポーネントを作成して構成した後で VSTA IDE を開くと、コードエディターには ScriptMain クラスが編集可能な状態で表示されます。また、ProcessInputRow メソッドがスタブとして表示されます。カスタムコードは ScriptMain クラスに記述します。また、ProcessInputRow は変換コンポーネントの最重要メソッドです。

VSTA の [プロジェクトエクスプローラー] ウィンドウを開くと、スクリプトコンポーネントにより、BufferWrapper および ComponentWrapper というプロジェクトアイテムが、読み取り専用の状態で自動生成されていることもわかります。ScriptMain クラスは、ComponentWrapper プロジェクトアイテム内の UserComponent クラスを継承します。

実行時には、データフローエンジンが UserComponent クラスの ProcessInput メソッドを呼び出します。これは親クラスである ScriptComponent の ProcessInput メソッドをオーバーライドします。ProcessInput メソッドは、入力バッファーに格納された行を順にループし、各行で 1 回ずつ ProcessInputRow メソッドを呼び出します。

カスタムコードの記述

同期出力型の変換コンポーネントは、記述するすべてのデータフローコンポーネントの中で最も単純です。たとえば、このトピックの単一出力の例は、次のカスタムコードで構成されています。

    Row.City = UCase(Row.City)

    Row.City = (Row.City).ToUpper();

同期型のカスタム変換コンポーネントの作成を完了するには、オーバーライドされた ProcessInputRow メソッドを使用して、入力バッファーにある各行のデータを変換します。データフローエンジンは、バッファーがいっぱいになると、データフロー内の次のコンポーネントにこのバッファーを渡します。

必要に応じて、ScriptMain クラスで使用できる PreExecute メソッドや PostExecute メソッドにもスクリプトを記述して、準備処理や終了後の処理を行う場合もあります。

複数の出力の処理

使用できる 2 つ以上の出力のいずれかに入力行を送信する場合でも、前述した単一出力の例と比べて、必要なカスタムコードはそれほど多くありません。たとえば、このトピックの 2 つの出力の例は、次のカスタムコードで構成されています。

 [Visual Basic]
    Row.City = UCase(Row.City)
    If Row.City = "REDMOND" Then
        Row.DirectRowToMyRedmondAddresses()
    Else
        Row.DirectRowToMyOtherAddresses()
    End If

 [C#]
        Row.City = (Row.City).ToUpper();

        if (Row.City=="REDMOND")
        {
            Row.DirectRowToMyRedmondAddresses();
        }
        else
        {
            Row.DirectRowToMyOtherAddresses();
        }

この例では、ユーザーが設定した出力の名前に基づき、スクリプトコンポーネントが DirectRowTo<OutputBufferX> メソッドを生成します。同様のコードを使用して、シミュレートされたエラー出力にエラー行を送信することもできます。

例

この例では、同期変換コンポーネントを作成するために、ScriptMain クラスで必要なカスタムコードを示します。

注
これらの例では、サンプルデータベース AdventureWorks2008R2 の Person.Address テーブルを使用して、その第 1 列および第 4 列、つまり int 型の AddressID および nvarchar(30) 型の City の各列を、データフローにそのまま渡します。このセクションの変換元、変換、および変換先の例でも、同じデータが使用されます。他の前提条件および仮定条件については、それぞれの例で説明します。

これらの例では、サンプルデータベース AdventureWorks2008R2 の Person.Address テーブルを使用して、その第 1 列および第 4 列、つまり int 型の AddressID および nvarchar(30) 型の City の各列を、データフローにそのまま渡します。このセクションの変換元、変換、および変換先の例でも、同じデータが使用されます。他の前提条件および仮定条件については、それぞれの例で説明します。

単一出力の同期変換の例

この例では、単一の出力が含まれる同期変換コンポーネントを示します。この変換は、AddressID 列を使用して City 列を大文字に変換します。

このサンプルコードを実行する場合は、パッケージやコンポーネントを次のように構成する必要があります。

新しいスクリプトコンポーネントを [データフロー] デザイナー画面に追加し、変換として構成します。
SSIS デザイナーで、変換元または他の変換の出力を、新しい変換コンポーネントに接続します。この出力には、サンプルデータベース AdventureWorks2008R2 の Person.Address テーブルから、AddressID 列および City 列を含むデータが渡される必要があります。
[スクリプト変換エディター] を開きます。[入力列] ページで、AddressID 列と City 列を選択します。City 列を、読み取り/書き込み可能としてマークします。
[入力および出力] ページで、入力と出力を MyAddressInput と MyAddressOutput などのわかりやすい名前に変更します。出力の SynchronousInputID は、入力の ID に対応していることに注意してください。したがって、出力列を追加して設定する必要はありません。
[スクリプト] ページで、[スクリプトの編集] をクリックし、続きのスクリプトを入力します。スクリプト開発環境と [スクリプト変換エディター] を閉じます。
SQL Server の変換先、または「スクリプトコンポーネントによる変換先の作成」で説明されている変換先コンポーネントの例など、AddressID および City 列が含まれる変換先コンポーネントを作成して構成します。変換の出力を変換先コンポーネントに接続します。AdventureWorks2008R2 データベースで次の Transact-SQL コマンドを実行して、変換先テーブルを作成できます。
```
CREATE TABLE [Person].[Address2](
    [AddressID] [int] NOT NULL,
    [City] [nvarchar](30) NOT NULL
)
```
サンプルを実行します。

Public Class ScriptMain
    Inherits UserComponent

    Public Overrides Sub MyAddressInput_ProcessInputRow(ByVal Row As MyAddressInputBuffer)

        Row.City = UCase(Row.City)

    End Sub

End Class

 [C#]
public class ScriptMain:
    UserComponent

{
    public override void MyAddressInput_ProcessInputRow(MyAddressInputBuffer Row)
    {

        Row.City = (Row.City).ToUpper();

    }

}

2 つの出力の同期変換の例

この例では、2 つの出力を持つ同期変換コンポーネントを示します。この変換は、AddressID 列を使用して City 列を大文字に変換します。都市名が Redmond の場合、変換はその行を 1 つの出力に送信し、他のすべての行をもう 1 つの出力に送信します。

このサンプルコードを実行する場合は、パッケージやコンポーネントを次のように構成する必要があります。

新しいスクリプトコンポーネントを [データフロー] デザイナー画面に追加し、変換として構成します。
SSIS デザイナーで、変換元または他の変換の出力を、新しい変換コンポーネントに接続します。この出力には、サンプルデータベース AdventureWorks2008R2 の Person.Address テーブルから、少なくとも AddressID 列および City 列を含むデータが渡される必要があります。
[スクリプト変換エディター] を開きます。[入力列] ページで、AddressID 列と City 列を選択します。City 列を、読み取り/書き込み可能としてマークします。
[入力および出力] ページで、2 番目の出力を作成します。新しい出力を追加したら、SynchronousInputID が入力の ID に設定されていることを確認します。このプロパティは、既定として作成された最初の出力で既に設定されています。各出力で、ExclusionGroup プロパティを 0 以外の同じ値に設定し、入力行を 2 つの相互排他的な出力に分割することを指定します。出力列を出力に追加する必要はありません。
入力と出力を、MyAddressInput、MyRedmondAddresses、MyOtherAddresses などのわかりやすい名前に変更します。
[スクリプト] ページで、[スクリプトの編集] をクリックし、続きのスクリプトを入力します。スクリプト開発環境と [スクリプト変換エディター] を閉じます。
SQL Server の変換先、フラットファイル変換先、または「スクリプトコンポーネントによる変換先の作成」で説明されている変換先コンポーネントの例など、AddressID および City 列が含まれる 2 つの変換先コンポーネントを作成して構成します。変換の各出力をいずれかの変換先コンポーネントに接続します。変換先テーブルを作成するには、AdventureWorks2008R2 データベースで次の Transact-SQL コマンドと同様のコマンド (一意のテーブル名を使用) を実行します。
```
CREATE TABLE [Person].[Address2](
    [AddressID] [int] NOT NULL,
    [City] [nvarchar](30) NOT NULL
```
サンプルを実行します。

Public Class ScriptMain
    Inherits UserComponent

    Public Overrides Sub MyAddressInput_ProcessInputRow(ByVal Row As MyAddressInputBuffer)

        Row.City = UCase(Row.City)

        If Row.City = "REDMOND" Then
            Row.DirectRowToMyRedmondAddresses()
        Else
            Row.DirectRowToMyOtherAddresses()
        End If

    End Sub

End Class

public class ScriptMain:
    UserComponent

public override void MyAddressInput_ProcessInputRow(MyAddressInputBuffer Row)
    {

        Row.City = (Row.City).ToUpper();

        if (Row.City == "REDMOND")
        {
            Row.DirectRowToMyRedmondAddresses();
        }
        else
        {
            Row.DirectRowToMyOtherAddresses();
        }

    }
}

最新の Integration Services の入手

Microsoft が提供する最新のダウンロード、アーティクル、サンプル、ビデオ、およびコミュニティで選択されたソリューションについては、MSDN または TechNet の Integration Services のページを参照してください。

これらの更新が自動で通知されるようにするには、ページの RSS フィードを定期受信します。

次の方法で共有

スクリプトコンポーネントによる同期変換の作成

同期変換コンポーネントの概要

メタデータデザインモードでの同期変換コンポーネントの構成

入力列の設定

入力、出力、および出力列の設定

変数の追加

コードデザインモードでの同期変換コンポーネントのスクリプト作成

自動生成されたコードについて

カスタムコードの記述

複数の出力の処理

例

単一出力の同期変換の例

2 つの出力の同期変換の例

関連項目

概念

その他のリソース

次の方法で共有

スクリプト コンポーネントによる同期変換の作成

同期変換コンポーネントの概要

メタデータ デザイン モードでの同期変換コンポーネントの構成

入力列の設定

入力、出力、および出力列の設定

変数の追加

コード デザイン モードでの同期変換コンポーネントのスクリプト作成

自動生成されたコードについて

カスタム コードの記述

複数の出力の処理

例

単一出力の同期変換の例

2 つの出力の同期変換の例

関連項目

概念

その他のリソース

スクリプトコンポーネントによる同期変換の作成

メタデータデザインモードでの同期変換コンポーネントの構成

コードデザインモードでの同期変換コンポーネントのスクリプト作成

カスタムコードの記述