ローカルパッケージの出力の読み込み

[アーティクル]
05/15/2023

適用対象: SQL Server Azure Data Factory の SSIS 統合ランタイム

クライアントアプリケーションは、ADO.NET を使用して SQL Server 変換先に出力が保存された場合、または System.IO 名前空間のクラスを使用してフラットファイル変換先に出力が保存された場合に、Integration Services パッケージの出力を読み取ることができます。ただし、メモリから直接、パッケージの出力を読み取ることもできます。その際、データを保持するための中間手段を必要としません。このソリューションの重要な点は、System.Data 名前空間からの IDbConnection、IDbCommand、および IDbDataParameter の各インターフェイスを特別に実装した Microsoft.SqlServer.Dts.DtsClient 名前空間です。既定では、アセンブリ Microsoft.SqlServer.Dts.DtsClient.dll は、%ProgramFiles%\Microsoft SQL Server\100\DTS\Binn にインストールされています。

重要

この記事で説明する、DtsClient ライブラリを使用する手順は、パッケージ配置モデル (つまり、/SQL、/DTS、または/File オプション) で配置されているパッケージに対してのみ使用できます。サーバー配置モデル (つまり、/ISServer オプション) で配置されているパッケージに対しては、この手順は使用できません。サーバー配置モデル (つまり、/ISServer オプション) で配置されているローカルパッケージの出力を使用するには、この記事で説明されている手順ではなく、Data Streaming Destination を使用します。

注意

このトピックで説明されている手順では、データフロータスクおよび親オブジェクトの 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、またはの Visual Basic Imports ステートメントを使用して、コードにこの名前空間をインポートします。
コードで、DtsClient.DtsConnection という種類のオブジェクトを作成します。このオブジェクトにある接続文字列には、パッケージの実行時に dtexec.exe で必要になるコマンドラインパラメーターが格納されます。詳細については、「dtexec ユーティリティ」を参照してください。次に、この接続文字列を使用して接続を開きます。 dtexecui ユーティリティを使用して、必要な接続文字列を視覚的に作成することもできます。

注意

このサンプルコードは、/FILE <path and filename> 構文を使用してファイルシステムからパッケージを読み込む方法を示していますが、 /SQL <package name> 構文を使用して MSDB データベースからパッケージを読み込んだり、/DTS \<folder name>\<package name> 構文を使用して Integration Services パッケージストアからパッケージを読み込むこともできます。
前に作成した DtsConnection を使用する DtsClient.DtsCommand という種類のオブジェクトを作成し、その CommandText プロパティに、パッケージ内の DataReader 変換先の名前を設定します。次に、コマンドオブジェクトの ExecuteReader メソッドを呼び出して、パッケージの結果を新しい DataReader に読み込みます。
必要に応じて、DtsCommand オブジェクトで DtsDataParameter オブジェクトのコレクションを使用して、パッケージに定義された変数に値を渡すことによって、パッケージの出力を間接的にパラメーター化できます。パッケージ内では、これらの変数をクエリパラメーターとして、または式で使用して、DataReader 変換先に返される結果に影響を与えることができます。クライアントアプリケーションから DtsDataParameter オブジェクトとこれらの変数を使用するには、あらかじめ DtsClient 名前空間でパッケージに変数を定義しておく必要があります ( [名前空間] 列を表示するには、 [変数] ウィンドウの [変数列の選択] ツールバーボタンをクリックする必要がある場合があります)。クライアントコードで、DtsDataParameter を DtsCommand の Parameters コレクションに追加する場合、変数名からの DtsClient 名前空間参照を省略してください。次に例を示します。
```
command.Parameters.Add(new DtsDataParameter("MyVariable", 1));  
```
出力データの行をループするのに必要なだけ、DataReader の Read メソッドを繰り返し呼び出します。クライアントアプリケーションで、データを使用するか、または後で使用するために保存します。

重要

DataReader のこの実装の Read メソッドは、データの最後の行が読み取られた後にもう一度 true を返します。このため、Read が true を返している間、DataReader をループする通常のコードを使用することが難しくなります。予定した行数を読み取った後に Read メソッドの追加の最終呼び出しがないと、コードで DataReader または接続を閉じようとした場合に、ハンドルされない例外が発生します。しかし、コードがこのループの最後の反復でデータを読み取ろうとした場合、Read がまだ true を返しているのに最後の行に到達すると、ハンドルされていない ApplicationException が発生し、"SSIS IDataReader は結果セットの末尾に到達しました" というメッセージが表示されます。この動作は、その他の DataReader 実装の動作とは異なります。したがって、Read が true を返している間にループを使用して DataReader 内の行を最後まで読み取るようにするには、最後の Read メソッドの正常な呼び出しで予想されるこの ApplicationException をキャッチ、テスト、および破棄するコードを記述する必要があります。あるいは、予定の行数があらかじめわかっている場合は、行を処理してから、DataReader および接続を閉じる前にもう一度 Read メソッドを呼び出します。
DtsCommand オブジェクトの Dispose メソッドを呼び出します。 DtsDataParameter オブジェクトを使用している場合、これは特に重要です。
DataReader と接続オブジェクトを閉じます。

例

次の例では、1 つの集計値を計算してその値を DataReader 変換先に保存するパッケージを実行します。次に、この値を DataReader から読み取って、Windows フォーム上のテキストボックスに表示します。

パッケージの出力をクライアントアプリケーションに読み込む場合は、パラメーターを使用する必要はありません。パラメーターを使用しない場合は、DtsClient 名前空間で変数を使用する必要はありません。DtsDataParameter オブジェクトを使用するコードも省略できます。

テストパッケージを作成するには

新しい Integration Services パッケージを作成します。サンプルコードでは、パッケージの名前として "DtsClientWParamPkg.dtsx" が使用されています。
DtsClient 名前空間に文字列型の変数を追加します。サンプルコードでは、変数の名前として Country が使用されています ([名前空間] 列を表示するには、[変数] ウィンドウの [変数列の選択] ツールバーボタンをクリックする必要がある場合があります)。
AdventureWorks2022 サンプルデータベースに接続する OLE DB 接続マネージャーを追加します。
データフロータスクをパッケージに追加し、[データフロー] デザイン画面に切り替えます。
OLE DB ソースをデータフローに追加し、前に作成した OLE DB 接続マネージャーを使用するように構成して、次の SQL コマンドを実行します。
```
SELECT * FROM Sales.vIndividualCustomer WHERE CountryRegionName = ?  
```
[パラメーター] をクリックし、[クエリパラメーターの設定] ダイアログボックスで、クエリの単一入力パラメーター Parameter0 を DtsClient::Country 変数にマップします。
データフローに集計変換を追加し、OLE DB ソースの出力を変換に接続します。集計変換エディターを開いて、すべての入力列 (*) で "すべてのカウント" 操作が実行され、集計された値が CustomerCount の別名で出力されるように構成します。
データフローに DataReader 変換先を追加し、集計変換の出力を DataReader 変換先に接続します。サンプルコードでは、DataReader の名前として "DataReaderDest" が使用されています。変換先に対して使用可能な単一の入力列 CustomerCount を選択します。
パッケージを保存します。次に作成されたテストアプリケーションではパッケージが実行され、その出力がメモリから直接取得されます。

テストアプリケーションを作成するには

新しい Windows フォームアプリケーションを作成します。
%ProgramFiles%\Microsoft SQL Server\100\DTS\Binn で同じ名前のアセンブリを参照して、Microsoft.SqlServer.Dts.DtsClient 名前空間への参照を追加します。
次のサンプルコードをコピーし、フォームのコードモジュールに貼り付けます。
パッケージを実行するために dtexec.exe で必要なコマンドラインパラメーターを格納するため、必要に応じて dtexecArgs 変数の値を変更します。サンプルコードは、ファイルシステムからパッケージを読み込みます。
パッケージ内の DataReader 変換先の名前を格納するため、必要に応じて dataReaderName 変数の値を変更します。
ボタンとテキストボックスをフォームに追加します。サンプルコードでは、ボタンの名前として 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;  
  
    }  
  }  
}

参照

ローカル実行とリモート実行の相違点について
 プログラムによるローカルパッケージの読み込みと実行
 プログラムによるリモートパッケージの読み込みと実行

次の方法で共有

ローカルパッケージの出力の読み込み

説明

クライアントアプリケーションにパッケージ出力を読み込むには

例

テストパッケージを作成するには

テストアプリケーションを作成するには

サンプルコード

参照

フィードバック

その他のリソース

次の方法で共有

ローカル パッケージの出力の読み込み

説明

クライアント アプリケーションにパッケージ出力を読み込むには

例

テスト パッケージを作成するには

テスト アプリケーションを作成するには

サンプル コード

参照

フィードバック

その他のリソース

ローカルパッケージの出力の読み込み

クライアントアプリケーションにパッケージ出力を読み込むには

テストパッケージを作成するには

テストアプリケーションを作成するには

サンプルコード