DataReader によるデータの取得

[アーティクル]
03/28/2008

ADO.NET の DataReader を使用して、データベースから前方への読み取り専用のストリームを取得できます。結果はクエリを実行すると返され、DataReader の Read メソッドを使用して要求するまで、クライアントのネットワークバッファに格納されます。DataReader を使用すると、アプリケーションのパフォーマンスが向上します。これは、クエリの結果がすべて返されるまで待たずに、使用可能になったデータをすぐに取得するためと、一度に 1 つの行しかメモリに格納しない (既定の設定) ことによってシステムのオーバーヘッドが軽減されるためです。

Command オブジェクトのインスタンスを作成した後、次の例に示すように Command.ExecuteReader を呼び出して DataReader を作成し、データソースから行を取得します。

Dim myReader As SqlDataReader = myCommand.ExecuteReader()
[C#]
SqlDataReader myReader = myCommand.ExecuteReader();

クエリの結果から行を取得するには、DataReader オブジェクトの Read メソッドを使用します。返された行の各列にアクセスするには、その列の名前または序数参照を DataReader に渡します。一方で DataReader は、最適のパフォーマンスが得られるように、ネイティブのデータ型を使用して列の値にアクセスするための一連のメソッド (GetDateTime、GetDouble、GetGuid、GetInt32 など) も提供します。型指定されたアクセサメソッドのリストについては、「OleDbDataReader クラス」および「SqlDataReader クラス」を参照してください。基になるデータ型がわかっているときに型指定されたアクセサメソッドを使用すると、列の値を取得するときに必要な型変換の量が少なくなります。

メモ .NET Framework Version 1.1 には、DataReader の追加のプロパティ HasRows が含まれているため、これを使用すると、読み取る前に DataReader が結果を返したかどうかを確認できます。

次に、DataReader オブジェクトを反復処理して各行から 2 つの列を返すサンプルコードを示します。

If myReader.HasRows Then
  Do While myReader.Read()
    Console.WriteLine(vbTab & "{0}" & vbTab & "{1}", myReader.GetInt32(0), myReader.GetString(1))
  Loop
Else
  Console.WriteLine("No rows returned.")
End If

myReader.Close()
[C#]
if (myReader.HasRows)
  while (myReader.Read())
    Console.WriteLine("\t{0}\t{1}", myReader.GetInt32(0), myReader.GetString(1));
else
  Console.WriteLine("No rows returned.");

myReader.Close();

DataReader はバッファリングされないデータストリームを提供して、手続きロジックがデータソースからの結果を順番に効率的に処理できるようにします。DataReader はデータをメモリにキャッシュしないため、大量のデータを取得する場合に適しています。

DataReader の終了

DataReader を使い終えたら、Close メソッドを呼び出す必要があります。

Command に出力パラメータや戻り値が含まれていても、DataReader が終了するまでは使用できません。

DataReader が開いている間、Connection はその DataReader によって排他的に使用されています。元の DataReader が終了するまでは、その Connection に対してはどのコマンドも実行できません。別の DataReader を作成することもできません。

メモクラスの Finalize メソッド内で Connection、DataReader、またはその他のマネージオブジェクトの Close または Dispose を呼び出さないでください。終了処理では、クラスに直接所有されているアンマネージリソースだけを解放してください。クラスがアンマネージリソースを所有していない場合は、クラス定義に Finalize メソッドを含めないでください。詳細については、「ガベージコレクションのプログラミング」を参照してください。

複数結果セット

複数の結果セットが返された場合は、次のサンプルコードで示すように、DataReader は NextResult メソッドを提供してその結果セットを順に反復処理します。

Dim myCMD As SqlCommand = New SqlCommand("SELECT CategoryID, CategoryName FROM Categories;" & _
                                         "SELECT EmployeeID, LastName FROM Employees", nwindConn)
nwindConn.Open()

Dim myReader As SqlDataReader = myCMD.ExecuteReader()

Dim fNextResult As Boolean = True
Do Until Not fNextResult
  Console.WriteLine(vbTab & myReader.GetName(0) & vbTab & myReader.GetName(1))

  Do While myReader.Read()
    Console.WriteLine(vbTab & myReader.GetInt32(0) & vbTab & myReader.GetString(1))
  Loop

  fNextResult = myReader.NextResult()
Loop

myReader.Close()
nwindConn.Close()
[C#]
SqlCommand myCMD = new SqlCommand("SELECT CategoryID, CategoryName FROM Categories;" +
                                  "SELECT EmployeeID, LastName FROM Employees", nwindConn);
nwindConn.Open();

SqlDataReader myReader = myCMD.ExecuteReader();

do
{
  Console.WriteLine("\t{0}\t{1}", myReader.GetName(0), myReader.GetName(1));

  while (myReader.Read())
    Console.WriteLine("\t{0}\t{1}", myReader.GetInt32(0), myReader.GetString(1));

} while (myReader.NextResult());

myReader.Close();
nwindConn.Close();

DataReader からのスキーマ情報の取得

DataReader が開いている間に GetSchemaTable メソッドを使用して、現在の結果セットについてのスキーマ情報を取得できます。GetSchemaTable は、現在の結果セットのスキーマ情報を含む行と列が設定されている DataTable オブジェクトを返します。DataTable には結果セットの列ごとに 1 行が設定されます。スキーマテーブル行の各列が、結果セットで返される列の 1 つのプロパティに割り当てられます。ColumnName はそのプロパティの名前であり、列の値はプロパティの値です。DataReader のスキーマ情報を出力するサンプルコードを次に示します。

Dim schemaTable As DataTable = myReader.GetSchemaTable()

Dim myRow As DataRow
Dim myCol As DataColumn

For Each myRow In schemaTable.Rows
  For Each myCol In schemaTable.Columns
    Console.WriteLine(myCol.ColumnName & " = " & myRow(myCol).ToString())
  Next
  Console.WriteLine()
Next
[C#]
DataTable schemaTable = myReader.GetSchemaTable();

foreach (DataRow myRow in schemaTable.Rows)
{
  foreach (DataColumn myCol in schemaTable.Columns)
    Console.WriteLine(myCol.ColumnName + " = " + myRow[myCol]);
  Console.WriteLine();
}

OLE DB のチャプタ

階層構造の行セット、つまりチャプタ (OLE DB では DBTYPE_HCHAPTER 型、ADO では adChapter 型) は OleDbDataReader を使用して取得できます。チャプタを含むクエリが DataReader として返されるとき、チャプタはその DataReader の列として返され、DataReader オブジェクトとして公開されます。

ADO.NET の DataSet を使用することで、テーブル間の親子のリレーションシップを使用して階層構造の行セットを表現することもできます。詳細については、「DataSet の作成および使用」を参照してください。

MSDataShape プロバイダを使用して、顧客リストの顧客別オーダーのチャプタ列を生成するサンプルコードを次に示します。

Dim nwindConn As OleDbConnection = New OleDbConnection("Provider=MSDataShape;Data Provider=SQLOLEDB;" & _
                                         "Data Source=localhost;Integrated Security=SSPI;Initial Catalog=northwind")

Dim custCMD As OleDbCommand = New OleDbCommand("SHAPE {SELECT CustomerID, CompanyName FROM Customers} " & _
                                         "  APPEND ({SELECT CustomerID, OrderID FROM Orders} AS CustomerOrders " & _
                                         "  RELATE CustomerID TO CustomerID)", nwindConn)
nwindConn.Open()

Dim custReader As OleDbDataReader = custCMD.ExecuteReader()
Dim orderReader As OleDbDataReader

Do While custReader.Read()
  Console.WriteLine("Orders for " & custReader.GetString(1)) ' custReader.GetString(1) = CompanyName

  orderReader = custReader.GetValue(2)                       ' custReader.GetValue(2) = Orders chapter as DataReader

  Do While orderReader.Read()
    Console.WriteLine(vbTab & orderReader.GetInt32(1))       ' orderReader.GetInt32(1) = OrderID
  Loop
  orderReader.Close()
Loop

custReader.Close()
nwindConn.Close()
[C#]
OleDbConnection nwindConn = new OleDbConnection("Provider=MSDataShape;Data Provider=SQLOLEDB;" +
                                                "Data Source=localhost;Integrated Security=SSPI;Initial Catalog=northwind");

OleDbCommand custCMD = new OleDbCommand("SHAPE {SELECT CustomerID, CompanyName FROM Customers} " +
                                      "  APPEND ({SELECT CustomerID, OrderID FROM Orders} AS CustomerOrders " +
                                      "  RELATE CustomerID TO CustomerID)", nwindConn);
nwindConn.Open();

OleDbDataReader custReader = custCMD.ExecuteReader();
OleDbDataReader orderReader;

while (custReader.Read())
{
  Console.WriteLine("Orders for " + custReader.GetString(1)); 
// custReader.GetString(1) = CompanyName

  orderReader = (OleDbDataReader)custReader.GetValue(2);      
// custReader.GetValue(2) = Orders chapter as DataReader

  while (orderReader.Read())
    Console.WriteLine("\t" + orderReader.GetInt32(1));        
// orderReader.GetInt32(1) = OrderID
  orderReader.Close();
}

custReader.Close();
nwindConn.Close();

Oracle REF CURSOR

.NET Framework Data Provider for Oracle は、クエリ結果を返すために、Oracle REF CURSOR の使用をサポートしています。Oracle REF CURSOR は OracleDataReader として返されます。

Oracle REF CURSOR を表す OracleDataReader オブジェクトは、OracleCommand.ExecuteReader メソッドで取得できます。また、DataSet にデータを格納するために使用する OracleDataAdapter の SelectCommand として、1 つ以上の Oracle REF CURSOR を返す OracleCommand を指定することもできます。

Oracle データソースから返された REF CURSOR にアクセスするには、クエリ用の OracleCommand を作成し、その Parameters コレクションに、REF CURSOR を参照する出力パラメータを追加します。パラメータの名前は、クエリの REF CURSOR パラメータの名前と一致させる必要があります。パラメータの型を OracleType.Cursor に設定します。OracleCommand の ExecuteReader メソッドは REF CURSOR に対する OracleDataReader を返します。

OracleCommand が複数の REF CURSOR を返す場合は、複数の出力パラメータを追加してください。OracleCommand.ExecuteReader メソッドを呼び出して、それぞれの REF CURSOR にアクセスできます。ExecuteReader を呼び出すと、最初の REF CURSOR を参照する OracleDataReader が返されます。次に OracleDataReader.NextResult メソッドを呼び出すと、後続の REF CURSOR にアクセスできます。OracleCommand.Parameters コレクションのパラメータが REF CURSOR 出力パラメータと名前が一致していても、OracleDataReader は、Parameters コレクションに追加された順に出力パラメータにアクセスします。

たとえば、次のような Oracle パッケージとパッケージ本体があるとします。

CREATE OR REPLACE PACKAGE CURSPKG AS 
  TYPE T_CURSOR IS REF CURSOR; 
  PROCEDURE OPEN_TWO_CURSORS (EMPCURSOR OUT T_CURSOR, 
                              DEPTCURSOR OUT T_CURSOR); 
END CURSPKG;

CREATE OR REPLACE PACKAGE BODY CURSPKG AS 
  PROCEDURE OPEN_TWO_CURSORS (EMPCURSOR OUT T_CURSOR, 
                              DEPTCURSOR OUT T_CURSOR) 
  IS 
  BEGIN 
    OPEN EMPCURSOR FOR SELECT * FROM DEMO.EMPLOYEE; 
    OPEN DEPTCURSOR FOR SELECT * FROM DEMO.DEPARTMENT; 
  END OPEN_TWO_CURSORS; 
END CURSPKG;

OracleType.Cursor 型の 2 つのパラメータを Parameters コレクションに追加して、上の Oracle パッケージから REF CURSOR を返す OracleCommand を作成するコードを次に示します。

Dim cursCmd As OracleCommand = New OracleCommand("CURSPKG.OPEN_TWO_CURSORS", oraConn)
cursCmd.Parameters.Add("EMPCURSOR", OracleType.Cursor).Direction = ParameterDirection.Output
cursCmd.Parameters.Add("DEPTCURSOR", OracleType.Cursor).Direction = ParameterDirection.Output
[C#]
OracleCommand cursCmd = new OracleCommand("CURSPKG.OPEN_TWO_CURSORS", oraConn);
cursCmd.Parameters.Add("EMPCURSOR", OracleType.Cursor).Direction = ParameterDirection.Output;
cursCmd.Parameters.Add("DEPTCURSOR", OracleType.Cursor).Direction = ParameterDirection.Output;

OracleDataReader の Read メソッドと NextResult メソッドを使用して、上のコマンドの結果を返すコードを次に示します。REF CURSOR パラメータは順番に返されます。

oraConn.Open()

Dim cursCmd As OracleCommand = New OracleCommand("CURSPKG.OPEN_TWO_CURSORS", oraConn)
cursCmd.CommandType = CommandType.StoredProcedure
cursCmd.Parameters.Add("EMPCURSOR", OracleType.Cursor).Direction = ParameterDirection.Output
cursCmd.Parameters.Add("DEPTCURSOR", OracleType.Cursor).Direction = ParameterDirection.Output

Dim rdr As OracleDataReader = cursCmd.ExecuteReader()

Console.WriteLine(vbCrLf & "Emp ID" & vbTab & "Name")

Do While rdr.Read()
  Console.WriteLine("{0}" & vbTab & "{1}, {2}", rdr.GetOracleNumber(0), rdr.GetString(1), rdr.GetString(2))
Loop

rdr.NextResult()

Console.WriteLine(vbCrLf & "Dept ID" & vbTab & "Name")

Do While rdr.Read()
  Console.WriteLine("{0}" & vbTab & "{1}", rdr.GetOracleNumber(0), rdr.GetString(1))
Loop

rdr.Close()
oraConn.Close()
[C#]
oraConn.Open();

OracleCommand cursCmd = new OracleCommand("CURSPKG.OPEN_TWO_CURSORS", oraConn);
cursCmd.CommandType = CommandType.StoredProcedure;
cursCmd.Parameters.Add("EMPCURSOR", OracleType.Cursor).Direction = ParameterDirection.Output;
cursCmd.Parameters.Add("DEPTCURSOR", OracleType.Cursor).Direction = ParameterDirection.Output;

OracleDataReader rdr = cursCmd.ExecuteReader();

Console.WriteLine("\nEmp ID\tName");

while (rdr.Read())
  Console.WriteLine("{0}\t{1}, {2}", rdr.GetOracleNumber(0), rdr.GetString(1), rdr.GetString(2));

rdr.NextResult();

Console.WriteLine("\nDept ID\tName");

while (rdr.Read())
  Console.WriteLine("{0}\t{1}", rdr.GetOracleNumber(0), rdr.GetString(1));

rdr.Close();
oraConn.Close();

上のコマンドを使用して、Oracle パッケージの結果を DataSet に設定するコード例を次に示します。

メモ DataRow に値を格納する前に Oracle の NUMBER 型から有効な .NET Framework のデータ型への変換も行って、OverflowException が発生しないようにすることをお勧めします。FillError イベントを使用して、OverflowException が発生したかどうかを確認できます。FillError イベントの詳細については、「DataAdapter イベントの使用」を参照してください。

Dim ds As DataSet = New DataSet()

Dim oraDa As OracleDataAdapter = New OracleDataAdapter(cursCmd)
oraDa.TableMappings.Add("Table", "Employees")
oraDa.TableMappings.Add("Table1", "Departments")

oraDa.Fill(ds)
[C#]
DataSet ds = new DataSet();

OracleDataAdapter oraDa = new OracleDataAdapter(cursCmd);
oraDa.TableMappings.Add("Table", "Employees");
oraDa.TableMappings.Add("Table1", "Departments");

oraDa.Fill(ds);

参照

.NET Framework データプロバイダによるデータのアクセス | DataTable クラス | OleDbDataReader クラス | SqlDataReader クラス

次の方法で共有