■ DataAdapter クラス ■ ■ DataAdapter クラスの概要 DataSet へのデータの格納やデータソースの更新に使用される一連の SQL コマンドとデータベース接 続を表す。 DataAdapter は、DataSet とデータソースとの間でデータの取得と保存を行う為の、ブリッジの役割を 果たす。DataAdapter は、此のブリッジを提供する為に、DataSet 内のデータをデータソース内のデー タと一致する様に変更する Fill と、データソース内のデータを DataSet 内のデータと一致する様に変 更するUpdate で、割り当てを行う。 SQL Server データベースに接続する場合は、関連付けられた SqlCommand オブジェクトや SqlConnection オブジェクトと共に SqlDataAdapter を使用する事に依り、全体的なパフォーマンスを 向上させる事が出来る。OLE DB をサポートするデータソースに接続する場合は、関連付けられた OleDbCommand オブジェクトや OleDbConnection オブジェクトと共に DataAdapter を使用する。 ODBC をサポートするデータソースに接続する場合は、関連付けられた OdbcCommand オブジェクト やOdbcConnection オブジェクトと共に DataAdapter を使用する。Oracle データベースに接続する場 合は、関連付けられた OracleCommand オブジェクトや OracleConnection オブジェクトと共に DataAdapter を使用する。 DataAdapter のインスタンスを作成すると、読み書き可能プロパティが初期値に設定される。此等の初 期値の一覧に付いては、DataAdapter コンストラクタの記述を参照され度い。 ■ コンストラクタ DataAdapter クラスの新しいインスタンスを初期化する。 オーバーロードの一覧
.NET Compact Framework に依ってサポートされて居る。
名前 説明
DataAdapter ( ) DataAdapter クラスの新しいインスタンスを初期化する。
DataAdapter (DataAdapter) 既存の同じ型のオブジェクトから、DataAdapter クラスの新しいインスタンス を初期化する。
■ パブリックプロパティ
名前 説明
AcceptChangesDuringFill Fill 操作中に DataTable に DataRow が 追加された後で、 其の行に対して AcceptChanges を呼び出すか何うかを示す値を取得・設定する。
AcceptChangesDuringUpdate Update で AcceptChanges が呼び出されるか何うかを取得・設定する。 Container Component を格納して居る IContainer を取得する。
デ
ContinueUpdateOnError 行の更新中にエラーが発生した時に、例外を生成するか何うかを指定する値を取 得・設定する。
FillLoadOption アダプタが DbDataReader から DataTable にデータを読み込む方法を決定する LoadOption を取得・設定する。 MissingMappingAction 一致するテーブルや列が受信データに含まれて居ない場合に実行するアクション を決定する。 MissingSchemaAction 既存の DataSet スキーマが受信データと一致しない時に実行するアクションを決 定する。 ReturnProviderSpecificTypes Fill メソッドがプロバイダ固有の値、又は、共通の CLS 準拠の値の孰れを返すか を取得・設定する。
Site Component の ISite を取得・設定する。
TableMappings ソーステーブルと DataTable との間のマスターマップを提供するコレクションを 取得する。 ■ パブリックメソッド 名前 説明 CreateObjRef リモートオブジェクトとの通信に使用するプロキシの生成に必要 な情報を総て格納して居るオブジェクトを作成する。 Dispose DataAdapter に依って使用されて居るリソースを解放する。 Equals 2 つの Object インスタンスが等しいか何うかを判断する。 Fill DataSet 名を使用して、データソース内の行と一致する様に、 DataSet 内の行を追加・更新する。亦、DataTable を作成する。
FillSchema DataTable を指定した DataSet に追加する。
GetFillParameters SQL SELECT ステートメントの実行時にユーザーが設定したパラ メータを取得する。 GetHashCode 特定の型のハッシュ関数と仕て機能する。GetHashCode は、ハッ シュアルゴリズムや、ハッシュテーブルの様なデータ構造での使用 に適して居る。 GetLifetimeService 対象のインスタンスの有効期間ポリシーを制御する現在の有効期 間サービスオブジェクトを取得する。 GetType 現在のインスタンスのType を取得する。 InitializeLifetimeService 対象のインスタンスの有効期間ポリシーを制御する有効期間サー ビスオブジェクトを取得する。 ReferenceEquals 指定した複数のObject インスタンスが同一か何うかを判断する。
ResetFillLoadOption FillLoadOption を 既 定 の 状 態 に リ セ ッ ト し 、 Fill で AcceptChangesDuringFill を受け入れる様にする。
ShouldSerializeAcceptChangesDuringFill AcceptChangesDuringFill プロパティを永続化する必要が有るか 何うかを決定する。
ShouldSerializeFillLoadOption FillLoadOption プロパティを永続化する必要が有るか何うかを決 定する。
ToString Component の名前を格納して居る String を返す（存在する場合）。
此のメソッドはオーバーライド出来ない。
Update 指定されたDataSet 内の "Table" と謂う名前の DataTable に含ま れる挿入行、更新行、又は、削除行に対して、INSERT、UPDATE、 又は、DELETE ステートメントを個別に呼び出す。
■ プロテクトメソッド
名前 説明
CloneInternals 此のDataAdapter のインスタンスのコピーを作成する。 CreateTableMappings 新しいDataTableMappingCollection を作成する。
Dispose DataAdapter に依って使用されて居るリソースを解放する。
Fill DataSet 名を使用して、データソース内の行と一致する様に、DataSet 内の行を
追加・更新する。亦、DataTable を作成する。 FillSchema DataTable を指定した DataSet に追加する。
Finalize Component がガベージコレクションに依ってクリアされる前に、アンマネージリ
ソースを解放し、其の他のクリーンアップ操作を実行する。
GetService Component や其の Container で提供されるサービスを表すオブジェクトを返す。 HasTableMappings DataTableMappingCollection が作成されて居るか何うかを示す。 MemberwiseClone OnFillError Fill 中にエラーが発生した時に呼び出される。 ShouldSerializeTableMappings 1 つ以上の DataTableMapping オブジェクトが存在し、其等を永続化する必要が 有るか何うかを確認する。 ■ パブリックイベント 名前 説明 Disposed コンポーネントのDisposed イベントを待機するイベントハンドラを追加する。 FillError 格納操作中にエラーが発生した時に返される。
■ DataAdapter クラスの利用 ■ ■ 此のセクションの内容 DataAdapter からの DataSet の読み込み（4 頁） DataAdapter を使用して DataSet にテーブル、列、及び、行を設定する方法に付いて説明する。 DataAdapter に依るパラメータの使用（13 頁） DataAdapter のコマンドプロパティのパラメータを使用する方法と、DataSet の列の内容をコマンド パラメータに割り当てる方法に付いて説明する。 パラメータと戻り値の指定（19 頁） DataAdapter 及び DataSet を使用した、入力、出力、及び、ストアドプロシージャの戻り値の使い方 に付いて説明する。 DataAdapter イベントの使用（34 頁） DataAdapter イベントと、其等のイベントを使用する方法に付いて説明する。 DataSet への既存の制約の追加（32 頁） 既存の制約をDataSet に追加する方法に付いて説明する。 ID 値と Autonumber 値の取得（37 頁）
Microsoft SQL Server テーブルの identity 列、又は、Microsoft Access テーブルの Autonumber フィ ールド用に生成された値を、テーブルの挿入行の列に割り当てる例を示する。
DataTable と DataColumn のマップの設定（11 頁）
DataAdapter の DataTableMappings と ColumnMappings のセットアップ方法に付いて説明する。
DataAdapter に依るデータソースの更新（23 頁） DataSet のデータに加えた変更を解決してデータソースに戻る方法に付いて説明する。 クエリ結果のページング（9 頁） DataAdapter に依るバッチ更新の実行（21 頁） DataAdapter に依る UDT 列の更新（27 頁） ■ DataAdapter からの DataSet の読み込み ADO.NET の DataSet は、データソースに依存しない一貫したリレーショナルプログラミングモデルを 提供するメモリ常駐型のデータ表現で有る。DataSet は、テーブル、制約、及び、テーブル間のリレー ションシップを含む完全なデータのセットを表す。DataSet は、データソースとは独立して居る為、 DataSet には其のアプリケーションに固有のデータと複数のデータソースからのデータを含める事が 出来る。既存のデータソースとの対話は、DataAdapter に依って制御される。
DataAdapter の SelectCommand プロパティは、データソースからデータを取得する Command オブ ジェクトで有る。DataAdapter の InsertCommand、UpdateCommand、DeleteCommand の各プロパ ティは、DataSet のデータに対して行われた変更に基づいてデータソースのデータ更新を管理する Command オブジェクトで有る。此等のプロパティに付いては、「DataAdapter に依るデータソースの 更新」で更に詳しく説明する。
DataAdapter の Fill メソッドは、DataAdapter の SelectCommand の結果を使用して DataSet を設定 する為に使用する。Fill は、自らの引数と仕て、設定対象で有る DataSet と、DataTable オブジェクト （詰まり、SelectCommand が返した行を格納して居る DataTable の名前）を受け取る。
Fill メソッドは、DataReader オブジェクトを暗黙的に使用して DataSet 内でテーブルを作成する為の 列の名前と型、及び、DataSet 内のテーブルの行を設定する為のデータを返す。テーブルや列は、存在 しない場合に丈作成される。既に存在する場合は、Fill は既存の DataSet スキーマを使用する。列の型 は、「.NET Framework データプロバイダのデータ型から.NET Framework のデータ型への変換」の表 に 基 づ き.NET Framework の 型 と 仕 て 作 成 さ れ る 。 デ ー タ ソ ー ス に 主 キ ー が 存 在 し 、 DataAdapter.MissingSchemaAction が MissingSchemaAction.AddWithKey に設定されて居る場合丈、 主キーが作成されるが、其れ以外の場合は主キーは作成されない。Fill はテーブルに主キーが有る事が 解ると、主キー列の値がデータソースから返された主キー列の値と一致する行に付いて、データソース から返されたデータでDataSet 内のデータを上書きする。主キーが見付からない場合は、DataSet のテ ーブルの末尾にデータを追加する。Fill は DataSet にデータを読み込む時に存在する総てのマッピング を使用する（「DataTable と DataColumn のマップの設定」を参照され度い）。
※ SelectCommand が OUTER JOIN の結果を返す場合、DataAdapter は、生成される DataTable に PrimaryKey 値を設定しない。開発者が PrimaryKey を定義して、重複行が正しく解決される様に
する必要が有る。詳細に付いては、「テーブルの主キーの定義」を参照され度い。
Microsoft SQL Server Northwind データベースへの SqlConnection を使用し DataSet 内の DataTable に 顧 客 リ ス ト を 読 み 込 む SqlDataAdapter の イ ン ス タ ン ス を 作 成 す る コ ー ド 例 を 次 に 示 す 。 SqlDataAdapter コンストラクタに渡される SQL ステートメントと SqlConnection 引数は、 SqlDataAdapter の SelectCommand プロパティを作成する為に使用される。
Visual Basic
' 変数 connection は、有効な SqlConnection オブジェクトとする。
Dim queryString As String = "SELECT CustomerID, CompanyName FROM dbo.Customers" Dim adapter As SqlDataAdapter = New SqlDataAdapter( queryString, connection)
Dim customers As DataSet = New DataSet adapter.Fill(customers, "Customers")
C#
// 変数 connection は、有効な SqlConnection オブジェクトとする。
string queryString = "SELECT CustomerID, CompanyName FROM dbo.Customers"; SqlDataAdapter adapter = new SqlDataAdapter(queryString, connection);
DataSet customers = new DataSet( ); adapter.Fill(customers, "Customers");
※ 此のコード例では、Connection の開始と終了を明示的に行って居ない。Fill メソッドは、接続が未 だ開いて居ない事を認識するとDataAdapter が使用して居る Connection を暗黙的に開く。Fill が 接続を開いた場合は、Fill の終了時に Fill が接続を終了する。此れに依り、Fill や Update 等の単一 の操作を扱う場合にコードを簡略化出来る。此れに対し、開いて居る接続を必要とする複数の操作 を実行する場合は、Connection の Open メソッドを明示的に呼び出し、データソースに対する操作 の実行後にConnection の Close メソッドを呼び出す事でアプリケーションのパフォーマンスを改善 出来る。リソースを解放して他のクライアントアプリケーションが使用出来る様にする為に、デー タソースへの接続を開いた儘にする時間は最小限にする事を推奨する。
複数結果セット
DataAdapter は複数の結果セットを検出すると、DataSet に複数のテーブルを作成する。此等のテーブ ルには、Table0 の様に、"Table" で始まるインクリメンタル既定名 TableN が割り当てられる。テーブ ル名を引数と仕てFill メソッドに渡すと、TableName0 を表す "TableName" で始まるインクリメンタ ル既定名TableNameN が割り当てられる。
複数のDataAdapter からの DataSet の読み込み
1 つの DataSet で、任意の数の DataAdapter オブジェクトを使用出来る。夫々れの DataAdapter で 1 つ以上のDataTable オブジェクトにデータを格納し、関連するデータソースに更新を反映させる事が出 来る。DataSet に対して、DataRelation オブジェクトや Constraint オブジェクトを部分的に追加出来 る為、開発者は複数の異なるデータソースから取得したデータを関連付ける事が出来る。例えば、 Microsoft SQL Server データベース、OLE DB を通じて公開される IBM DB2 データベース、及び、 XML をストリーム転送するデータソースからのデータを DataSet に含める事が出来る。1 つ以上の DataAdapter オブジェクトを使用して、各データソースとの通信を行う事が出来る。
例
次のコード例では、Microsoft SQL Server 2000 の Northwind データベースからの顧客リストと Microsoft Access 2000 に格納されて居る Northwind データベースからの注文リストを取得する。デー タが格納されて居るテーブルがDataRelation に関連付けられ、顧客の一覧が各顧客の注文と共に表示 される。DataRelation オブジェクトの詳細に付いては、「テーブル間のリレーションシップの追加」、 及び、「テーブル間のリレーションシップの移動」を参照され度い。 Visual Basic ' 変数 customerConnection は、有効な SqlConnection オブジェクトとする。 ' 変数 orderConnection は、有効な OleDbConnection オブジェクトとする。 Dim custAdapter As SqlDataAdapter = New SqlDataAdapter( _
"SELECT * FROM dbo.Customers", customerConnection)
Dim ordAdapter As OleDbDataAdapter = New OleDbDataAdapter( _ "SELECT * FROM Orders", orderConnection)
Dim customerOrders As DataSet = New DataSet( ) custAdapter.Fill(customerOrders, "Customers") ordAdapter.Fill(customerOrders, "Orders") Dim relation As DataRelation = _
customerOrders.Relations.Add("CustOrders", _
customerOrders.Tables("Customers").Columns("CustomerID"), _ customerOrders.Tables("Orders").Columns("CustomerID")) Dim pRow, cRow As DataRow
For Each pRow In customerOrders.Tables("Customers").Rows Console.WriteLine(pRow("CustomerID").ToString( ))
For Each cRow In pRow.GetChildRows(relation)
Console.WriteLine(vbTab & cRow("OrderID").ToString( )) Next
C#
// 変数 customerConnection は、有効な SqlConnection オブジェクトとする。 // 変数 orderConnection は、有効な OleDbConnection オブジェクトとする。 // Assumes that customerConnection is a valid SqlConnection object.
// Assumes that orderConnection is a valid OleDbConnection object. SqlDataAdapter custAdapter = new SqlDataAdapter(
"SELECT * FROM dbo.Customers", customerConnection); OleDbDataAdapter ordAdapter = new OleDbDataAdapter( "SELECT * FROM Orders", orderConnection);
DataSet customerOrders = new DataSet( ); custAdapter.Fill(customerOrders, "Customers"); ordAdapter.Fill(customerOrders, "Orders");
DataRelation relation = customerOrders.Relations.Add("CustOrders", customerOrders.Tables["Customers"].Columns["CustomerID"], customerOrders.Tables["Orders"].Columns["CustomerID"]);
foreach (DataRow pRow in customerOrders.Tables["Customers"].Rows) {
Console.WriteLine(pRow["CustomerID"]);
foreach (DataRow cRow in pRow.GetChildRows(relation)) Console.WriteLine("¥t" + cRow["OrderID"]);
}
SQL Server の 10 進数型
既定では、DataSet は、.NET Framework のデータ型を使用してデータを格納する。殆どのアプリケ ーションで、此等のデータ型を使用してデータソース情報を簡単に表示出来る。併し、データソースの データ型がSQL Server の 10 進数データ型や数値データ型の場合は、此の表現に依って問題が生じる 場合が有る。.NET Framework の decimal データ型の最大有効桁数は 28 桁で有るのに対し、SQL Server のdecimal データ型の有効桁数は 38 桁で有る。Fill が動作して居る間に、SqlDataAdapter が、SQL Server の decimal フィールドの有効桁数が 28 文字を超えて居ると判断した場合、現在の行は DataTable に追加されない。其の場合は FillError イベントが発生する為、開発者は有効桁数の消失が発生して居 ないか何うかを確認し、適切に対応出来る。FillError イベントの詳細に付いては、「DataAdapter イベ ントの使用」を参照され度い。SQL Server の decimal 値を取得するには、SqlDataReader オブジェク トを使用し、GetSqlDecimal メソッドを呼び出す事も出来る。
ADO.NET 2.0 では、DataSet の System.Data.SqlTypes に対するサポート機能が強化されて居る。詳 細に付いては、「SqlTypes と DataSet」を参照され度い。
OLE DB のチャプタ
階層構造の行セット、詰まり、チャプタ（OLE DB では DBTYPE_HCHAPTER 型、ADO では adChapter 型）を使用してDataSet の内容を格納出来る。OleDbDataAdapter が Fill が動作して居る間にチャプ タ列を検出すると、其のチャプタ列の為のDataTable を作成し、チャプタから取得した列と行を此のテ ーブルに格納する。チャプタ列用に作成されたテーブルには、親テーブルの名前とチャプタ列の名前の 両方を使用した "ParentTableNameChapteredColumnName" 形式の名前が割り当てられる。DataSet にチャプタ列の名前と一致するテーブルが既に存在する場合は、現在のテーブルにチャプタデータが格 納される。既存のテーブルにチャプタ内の列と一致する列が存在しない場合は、新しい列が追加される。
DataSet 内のテーブルにチャプタ列のデータを格納する前に、親テーブルと子テーブルの両方に 1 つの 整数列を追加し、親列を自動インクリメントに設定し、両方のテーブルに追加された列を使用して DataRelation を作成すると、階層構造の行セットを形成して居る親テーブルと子テーブルの間にリレ ーションが作成される。追加されたリレーションには親テーブルの名前とチャプタ列の名前を使用した "ParentTableNameChapterColumnName" 形式の名前が割り当てられる。 関連付けられた列は、DataSet 丈に存在する。其のデータソースからの次の Fill 操作を実行すると、変 更を既存の行にマージするのではなく、テーブルに新しい行が追加される。 DataTable を受け取る DataAdapter.Fill オーバーロードを使用した場合は、其のテーブル丈にデータ が格納される。自動インクリメント整数列は、引き続き其のテーブルに追加されるが、子テーブルの作 成、子テーブルへのデータの格納、及び、リレーションの作成は行われない。 MSDataShape プロバイダを使用して顧客リスト内の各顧客に対応するオーダー列を生成する例を次に 示す。チャプタ列を生成した後で、1 つの DataSet 内に其のデータを格納する。 Visual Basic
Using connection As OleDbConnection = New OleDbConnection( _ "Provider=MSDataShape;Data Provider=SQLOLEDB;" & _ "Data Source=(local);Integrated " & _
"Security=SSPI;Initial Catalog=northwind")
Dim adapter As OleDbDataAdapter = New OleDbDataAdapter( _
"SHAPE {SELECT CustomerID, CompanyName FROM Customers} " & _ "APPEND ({SELECT CustomerID, OrderID FROM Orders} AS Orders " & _ "RELATE CustomerID TO CustomerID)", connection)
Dim customers As DataSet = New DataSet( ) adapter.Fill(customers, "Customers")
End Using
C#
using (OleDbConnection connection = new OleDbConnection( "Provider=MSDataShape;Data Provider=SQLOLEDB;" +
"Data Source=(local);Integrated Security=SSPI;Initial Catalog=northwind")) {
OleDbDataAdapter adapter = new OleDbDataAdapter(
"SHAPE {SELECT CustomerID, CompanyName FROM Customers} " + "APPEND ({SELECT CustomerID, OrderID FROM Orders} AS Orders " + "RELATE CustomerID TO CustomerID)", connection);
DataSet customers = new DataSet( ); adapter.Fill(customers, "Customers"); }
Fill 操作が完了すると、DataSet に Customers と CustomersOrders の 2 つのテーブルが格納される。 CustomersOrders はチャプタ列を表す。Orders と謂う列が Customers テーブルに追加され、 CustomersOrders と謂う列が CustomersOrders テーブルに追加される。Customers テーブルの Orders 列は、自動インクリメントに設定される。親テーブルで有る Customers テーブルに追加された列を使 用して、CustomersOrders と謂う DataRelation が作成される。サンプル結果の一部を次の表に示す。
TableName:Customers
CustomerID CompanyName Orders
ALFKI Alfreds Futterkiste 0
ANATR Ana Trujillo Emparedados y helados 1 TableName:CustomersOrders
CustomerID OrderID CustomersOrders
ALFKI 10643 0 ALFKI 10692 0 ANATR 10308 1 ANATR 10625 1 ■ クエリ結果のページング クエリ結果のページングとは、クエリ結果をデータの小さなサブセット、詰まり、ページに分けて返す プロセスで有る。クエリ結果のページングは、結果を管理し易い小さな単位でユーザーに表示する為に 行われる一般的な処理で有る。 DataAdapter には、Fill メソッドのオーバーロードを通じて 1 ページ分のデータ丈を返す機能が用意さ れて居る。併し、此れは大きなクエリ結果のページングには適して居ない。DataAdapter が目的の DataTable、又は、DataSet に、要求されたレコード丈を格納する一方で、クエリ全体を返す為のリソ ースが使用される為で有る。クエリ全体を返す必要が有るリソースを使用せずにデータソースから1 ペ ージ分のデータを返すには、必要な行丈返す様に限定する抽出条件をクエリに追加する。 Fill メソッドを使用して 1 ページ分のデータを返すには、データページの先頭レコードを指定する startRecord パラメータとデータページのレコード数を指定する maxRecords パラメータを指定する。 Fill メソッドを使用してクエリ結果の最初のページ（ページサイズ：5 つのレコード）を返す方法を次 のコード例に示す。 Visual Basic Dim currentIndex As Integer = 0
Dim pageSize As Integer = 5
Dim orderSQL As String = "SELECT * FROM dbo.Orders ORDER BY OrderID" ' 変数 connection は、有効な SqlConnection オブジェクトとする。
Dim adapter As SqlDataAdapter = New SqlDataAdapter(orderSQL, connection) Dim dataSet As DataSet = New DataSet( )
adapter.Fill(dataSet, currentIndex, pageSize, "Orders") C# int currentIndex = 0;
int pageSize = 5;
string orderSQL = "SELECT * FROM Orders ORDER BY OrderID"; // 変数 connection は、有効な SqlConnection オブジェクトとする。 SqlDataAdapter adapter = new SqlDataAdapter(orderSQL, connection); DataSet dataSet = new DataSet( );
上記の例では、DataSet に 5 つのレコード丈が格納されるが、Orders テーブル全体が返される。DataSet
に此れと同じ 5 つのレコードを格納し、5 つのレコード丈を返すには、次のコード例に示す様に SQL
ステートメントでTOP 句と WHERE 句を使用する。 Visual Basic Dim pageSize As Integer = 5
Dim orderSQL As String = "SELECT TOP " & pageSize & _ " * FROM Orders ORDER BY OrderID"
Dim adapter As SqlDataAdapter = New SqlDataAdapter(orderSQL, connection) Dim dataSet As DataSet = New DataSet( )
adapter.Fill(dataSet, "Orders")
C# int pageSize = 5;
string orderSQL = "SELECT TOP " + pageSize + " * FROM Orders ORDER BY OrderID"; SqlDataAdapter adapter = new SqlDataAdapter(orderSQL, connection);
DataSet dataSet = new DataSet( ); adapter.Fill(dataSet, "Orders");
此の方法でクエリ結果をページングする時は、次のレコードページを返すコマンドに一意の ID を渡す
為に、行を順序付けする固有の識別子を保存する必要が有る。次のコード例で示す。 Visual Basic
Dim lastRecord As String = _
dataSet.Tables("Orders").Rows(pageSize - 1)("OrderID").ToString( ) C#
string lastRecord =
dataSet.Tables["Orders"].Rows[pageSize - 1]["OrderID"].ToString( );
startRecord パラメータと maxRecords パラメータを受け取る Fill メソッドのオーバーロードを使用し て次のレコードページを返すには、現在のレコードインデックスをページサイズの分丈インクリメント し、テーブルにレコードページを格納する。DataSet に 1 ページ分のレコード丈を追加する場合でも、 データベースサーバーはクエリ結果全体を返す事に注意され度い。次のデータページを格納する前にテ ーブル行をクリアするコード例を次に示す。データベースサーバーとの遣り取りを減らす為に、ローカ ルのキャッシュに、返された一定数の行を保存する事も出来る。 Visual Basic currentIndex = currentIndex + pageSize
dataSet.Tables("Orders").Rows.Clear( )
adapter.Fill(dataSet, currentIndex, pageSize, "Orders") C# currentIndex += pageSize;
dataSet.Tables["Orders"].Rows.Clear( );
データベースサーバーに依ってクエリ全体を返さずに次のレコードページを返すには、SELECT ステー トメントに限定的な抽出条件を指定する。上の例では最後に返されたレコードが保存されるが、次のコ
ード例に示す様に其のレコードをWHERE 句で使用するとクエリの開始点を指定出来る。
Visual Basic orderSQL = "SELECT TOP " & pageSize & _
" * FROM Orders WHERE OrderID > " & lastRecord & " ORDER BY OrderID" adapter.SelectCommand.CommandText = orderSQL
dataSet.Tables("Orders").Rows.Clear( ) adapter.Fill(dataSet, "Orders")
C# orderSQL = "SELECT TOP " + pageSize +
" * FROM Orders WHERE OrderID > " + lastRecord + " ORDER BY OrderID"; adapter.SelectCommand.CommandText = orderSQL;
dataSet.Tables["Orders"].Rows.Clear( ); adapter.Fill(dataSet, "Orders");
■ DataTable と DataColumn のマップの設定
DataAdapter は、TableMappings プロパティに 0 個以上の DataTableMapping オブジェクトのコレク ションを持って居る。DataTableMapping は、データソースに対するクエリで返されたデータと DataTable の間のマスタのマップを提供する。DataTableMapping 名は、DataAdapter の Fill メソッ ドにDataTable 名の代わりと仕て渡す事が出来る。Authors テーブルに対して AuthorsMapping と謂 う名前のDataTableMapping を作成する例を次に示す。 Visual Basic workAdapter.TableMappings.Add("AuthorsMapping", "Authors") C# workAdapter.TableMappings.Add("AuthorsMapping", "Authors"); DataTableMapping を使用すると、DataTable 内でデータベースの列名とは異なる列名を使用出来る。 DataAdapter は、テーブルの更新時に此のマップを使用して列を一致させる。
DataAdapter の Fill メソッドや Update メソッドを呼び出す時に TableName や DataTableMapping 名を指定しなかった場合、DataAdapter は "Table" と謂う名前の DataTableMapping を検索する。其 のDataTableMapping が存在しない場合は、DataTable の TableName が "Table" に成る。"Table" と 謂う名前のDataTableMapping を作成する事で既定の DataTableMapping を指定出来る。
次に示すのは、System.Data.Common 名前空間から DataTableMapping を作成し、其れに "Table" と 謂う名前を付けて、指定した DataAdapter の既定のマップと仕て設定するコード例で有る。此の例で は、其の後、クエリ結果の最初のテーブル（Northwind データベースの Customers テーブル）の列を DataSet の Northwind Customers テーブルに有る、より解り易い名前のセットに割り当てる。割り当 てられない列には、データソースの列名が使用される。
Visual Basic Dim mapping As DataTableMapping = _
adapter.TableMappings.Add("Table", "NorthwindCustomers") mapping.ColumnMappings.Add("CompanyName", "Company") mapping.ColumnMappings.Add("ContactName", "Contact") mapping.ColumnMappings.Add("PostalCode", "ZIPCode") adapter.Fill(custDS)
C# DataTableMapping mapping = adapter.TableMappings.Add("Table", "NorthwindCustomers"); mapping.ColumnMappings.Add("CompanyName", "Company"); mapping.ColumnMappings.Add("ContactName", "Contact"); mapping.ColumnMappings.Add("PostalCode", "ZIPCode"); adapter.Fill(custDS); 更に高度な条件下では、同じ DataAdapter を使用して複数の割り当てが設定された複数テーブルの読 み込みのサポートが必要な場合が有る。此の場合、DataTableMapping オブジェクトを追加する。 Fill メソッドに DataSet のインスタンスと DataTableMapping 名が渡された時、其の名前の割り当て が存在する場合は其の名前が使用され、存在しない場合は其の名前のDataTable が使用される。 次 に 示 す の は 、Customers と 謂 う 名 前 と BizTalkSchema と 謂 う DataTable 名 を 持 つ DataTableMapping を作成する例で有る。此の例では、其の後で、SELECT ステートメントで返され た行をBizTalkSchema DataTable に割り当てゝ居る。
Visual Basic Dim mapping As ITableMapping = _
adapter.TableMappings.Add("Customers", "BizTalkSchema") mapping.ColumnMappings.Add("CustomerID", "ClientID") mapping.ColumnMappings.Add("CompanyName", "ClientName") mapping.ColumnMappings.Add("ContactName", "Contact") mapping.ColumnMappings.Add("PostalCode", "ZIP") adapter.Fill(custDS, "Customers") C# ITableMapping mapping = adapter.TableMappings.Add("Customers", "BizTalkSchema"); mapping.ColumnMappings.Add("CustomerID", "ClientID"); mapping.ColumnMappings.Add("CompanyName", "ClientName"); mapping.ColumnMappings.Add("ContactName", "Contact"); mapping.ColumnMappings.Add("PostalCode", "ZIP"); adapter.Fill(custDS, "Customers"); ※ 列マップにソースの列名を指定しなかった場合、又は、テーブルマップにソーステーブル名を指定 しなかった場合は、自動的に既定の名前が生成される。列マップにソース列を指定しなかった場合 は、列マップにSourceColumn1 から始まるインクリメンタル既定名 SourceColumnN が割り当て ら れ る 。 テ ー ブ ル マ ッ プ に ソ ー ス テ ー ブ ル 名 を 指 定 し な か っ た 場 合 は 、 テ ー ブ ル マ ッ プ に SourceTable1 から始まるインクリメンタル既定名 SourceTableN が割り当てられる。 ※ 列マップには、SourceColumnN の命名規則を使用しない事、亦、テーブルの割り当てには SourceTableN を使用しない事を推奨する。此れは、指定した名前が ColumnMappingCollection 内 の既存する既定の列マップ名、又は、DataTableMappingCollection 内のテーブルマップ名と競合し ない様にする為で有る。指定した名前が既に存在する場合は、例外がスローされる。
複数結果セット
SelectCommand が複数のテーブルを返す場合、Fill は DataSet 内のテーブルに対するインクリメント 値を含むテーブル名を自動的に生成する。此れは、指定したテーブル名で開始し、TableNameN の形式 でTableName1 から数値を加算して行く名前に成る。自動的に生成されたテーブル名は、テーブルの割 り当てを使用してDataSet 内でテーブルに指定する名前に変換出来る。例えば、Customers と Orders と謂う2 つのテーブルを返す SelectCommand に対して、次の Fill 呼出を実行する。
Visual Basic、C# adapter.Fill(customersDataSet, "Customers")
DataSet 内に Customers と Customers1 と謂う 2 つのテーブルが作成される。テーブルマップを使用 して、2 つ目のテーブルに Customers1 と謂う名前の代わりに Orders と謂う名前を付ける事が出来る。 其れには、次の例に示す様に、ソーステーブルCustomers1 を DataSet テーブル Orders に割り当てる。
Visual Basic、C# adapter.TableMappings.Add("Customers1", "Orders") adapter.Fill(customersDataSet, "Customers") ■ DataAdapter に依るパラメータの使用 DataAdapter は、データソースからデータを取得したりデータソースのデータを更新したりする為に使 用される、次の4 つのプロパティを持って居る。SelectCommand プロパティは、データソースからデ ータを返す。InsertCommand、UpdateCommand、DeleteCommand の各プロパティは、データソー スの変更を管理する為に使用する。SelectCommand プロパティは DataAdapter の Fill メソッドを呼 び出す前に設定する必要が有る。InsertCommand、UpdateCommand、DeleteCommand の各プロパ ティは、DataAdapter の Update メソッドを呼び出す前に DataSet 内のデータに対して行われた変更 に基づいて設定する必要が有る。例えば、行が追加された場合、InsertCommand は Update 呼出の前 に設定されて居る必要が有る。Update が挿入行、更新行、又は、削除行を処理して居る時、DataAdapter が夫々れのCommand プロパティを使用して其のアクションを処理する。変更された行に付いての現在 の情報がParameters コレクションを通じて Command オブジェクトに渡される。 データソースの行を更新する時は、一意識別子を使用してテーブル内の更新する列を識別する UPDATE ステートメントを呼び出す。一意識別子は、一般には主キーフィールドの値で有る。UPDATE ステートメントは、次のTransact-SQL ステートメントで示す様に、一意識別子、及び、更新する列と 値の両方を含むパラメータを使用する。
UPDATE Customers SET CompanyName = @CompanyName WHERE CustomerID = @CustomerID
※ パラメータのプレースホルダの構文は、データソースに依って異なる。次に、SQL Server のデータ ソースのプレースホルダの例を示す。System.Data.OleDb パラメータと System.Data.Odbc パラメ ータのプレースホルダと仕て、疑問符（ ? ）を使用する。
此のVisual Basic の例では、CompanyName フィールドは、CustomerID が@CustomerID パラメータ の値と等しい列の@CompanyName パラメータの値で更新される。此等のパラメータは SqlParameter オブジェクトのSourceColumn プロパティを使用して、変更された行から情報を取得する。前のサンプ
ル UPDATE ステートメントのパラメータを次に示す。此のコードは、変数 adapter が有効な
Visual Basic adapter.Parameters.Add( _
"@CompanyName", SqlDbType.NChar, 15, "CompanyName") Dim parameter As SqlParameter = _
adapter.UpdateCommand.Parameters.Add("@CustomerID", _ SqlDbType.NChar, 5, "CustomerID")
parameter.SourceVersion = DataRowVersion.Original
Parameters コレクションの Add メソッドは、パラメータ名、DataAdapter 固有の型、サイズ（其の型 に適用可能な場合）、及び、DataTable の SourceColumn の名前を受け取る。@CustomerID パラメー タの SourceVersion が Original に設定されて居る事に注意され度い。此の設定に依り、変更済みの DataRow の中で、識別を行う 1 つ、又は、複数の列の値が既に変更されて居る場合に、データソース 内の既存の行を更新する事を保証出来る。識別列の値が既に変更されて居る場合は、Original 行の値は データソースの現在の値と一致し、Current 行の値は更新済みの値を格納する。@CompanyName パラ メータのSourceVersion は設定されて居ない為、既定の Current の行の値が使用される。 SqlClient の例 SQL ステートメントを SqlDataAdapter の SelectCommand、InsertCommand、UpdateCommand、 DeleteCommand の各プロパティの CommandText と仕て使用する例を次に示す。SqlDataAdapter オ ブジェクトの場合は、名前付きのパラメータを使用する必要が有る。
Visual Basic Dim selectSQL As String = _
"SELECT CustomerID, CompanyName FROM Customers " & _ "WHERE CountryRegion = @CountryRegion AND City = @City" Dim insertSQL As String = _
"INSERT INTO Customers (CustomerID, CompanyName) " & _ "VALUES (@CustomerID, @CompanyName)"
Dim updateSQL As String = _
"UPDATE Customers SET CustomerID = @CustomerID, & _ "CompanyName = @CompanyName " & _
"WHERE CustomerID = @OldCustomerID" Dim deleteSQL As String = _
"DELETE FROM Customers WHERE CustomerID = @CustomerID" C#
string selectSQL =
"SELECT CustomerID, CompanyName FROM Customers WHERE CountryRegion = " + "@CountryRegion AND City = @City";
string insertSQL = "INSERT INTO Customers (CustomerID, CompanyName) " + "VALUES (@CustomerID, @CompanyName)";
string updateSQL = "UPDATE Customers SET CustomerID = @CustomerID, " + "CompanyName = @CompanyName WHERE CustomerID = @OldCustomerID"; string deleteSQL =
"DELETE FROM Customers WHERE CustomerID = @CustomerID"; OleDb 又は Odbc の例
OleDbDataAdapter オブジェクトと OdbcDataAdapter オブジェクトの場合は、疑問符（ ? ）のプレ ースホルダを使用してパラメータを識別する必要が有る。
Visual Basic Dim selectSQL As String = _
"SELECT CustomerID, CompanyName FROM Customers " & _ "WHERE CountryRegion = ? AND City = ?"
Dim insertSQL AS String = _
"INSERT INTO Customers (CustomerID, CompanyName) VALUES (?, ?)" Dim updateSQL AS String = _
"UPDATE Customers SET CustomerID = ?, CompanyName = ? " & _ WHERE CustomerID = ?"
Dim deleteSQL As String = "DELETE FROM Customers WHERE CustomerID = ?" C#
string selectSQL =
"SELECT CustomerID, CompanyName FROM Customers " + "WHERE CountryRegion = ? AND City = ?";
string insertSQL =
"INSERT INTO Customers (CustomerID, CompanyName) " + "VALUES (?, ?)";
string updateSQL =
"UPDATE Customers SET CustomerID = ?, CompanyName = ? " + "WHERE CustomerID = ? ";
string deleteSQL = "DELETE FROM Customers WHERE CustomerID = ?";
パラメータと仕て使用されるクエリステートメントは、作成する必要の有る入力パラメータと出力パラ メータを定義する。パラメータを作成するには、Parameters.Add メソッド、又は、Parameter コンス トラクタを使用して列名、データ型、及び、サイズを指定する。Integer 等組み込みのデータ型の場合 は、サイズを含める必要は無いし、其の場合は自動的に既定のサイズを指定する事に成る。 前例のSQL ステートメントのパラメータを作成し、DataSet にデータを格納するコード例を次に示す。 SqlClient Visual Basic ' 変数 connection は、有効な SqlConnection オブジェクトとする。 Dim adapter As SqlDataAdapter = New SqlDataAdapter
Dim selectCMD AS SqlCommand = New SqlCommand(selectSQL, connection) adapter.SelectCommand = selectCMD
selectCMD.Parameters.Add("@CountryRegion", SqlDbType.NVarChar, 15).Value = "UK" selectCMD.Parameters.Add("@City", SqlDbType.NVarChar, 15).Value = "London" Dim customers As DataSet = New DataSet
adapter.Fill(customers, "Customers")
C#
// 変数 connection は、有効な SqlConnection オブジェクトとする。 SqlDataAdapter adapter = new SqlDataAdapter( );
SqlCommand selectCMD = new SqlCommand(selectSQL, connection); adapter.SelectCommand = selectCMD;
selectCMD.Parameters.Add("@CountryRegion", SqlDbType.NVarChar, 15).Value = "UK"; selectCMD.Parameters.Add("@City", SqlDbType.NVarChar, 15).Value = "London"; DataSet customers = new DataSet( );
OleDb
Visual Basic
' 変数 connection は、有効な OleDbConnection オブジェクトとする。 Dim adapter As OleDbDataAdapter = New OleDbDataAdapter
Dim selectCMD AS OleDbCommand = New OleDbCommand(selectSQL, connection) adapter.SelectCommand = selectCMD
selectCMD.Parameters.Add("@CountryRegion", OleDbType.VarChar, 15).Value = "UK" selectCMD.Parameters.Add("@City", OleDbType.VarChar, 15).Value = "London" Dim customers As DataSet = New DataSet
adapter.Fill(customers, "Customers")
C#
// 変数 connection は、有効な OleDbConnection オブジェクトとする。 OleDbDataAdapter adapter = new OleDbDataAdapter( );
OleDbCommand selectCMD = new OleDbCommand(selectSQL, connection); adapter.SelectCommand = selectCMD;
selectCMD.Parameters.Add("@CountryRegion", OleDbType.VarChar, 15).Value = "UK"; selectCMD.Parameters.Add("@City", OleDbType.VarChar, 15).Value = "London"; DataSet customers = new DataSet( );
adapter.Fill(customers, "Customers"); Odbc
Visual Basic
' 変数 connection は、有効な OdbcConnection オブジェクトとする。 Dim adapter As OdbcDataAdapter = New OdbcDataAdapter
Dim selectCMD AS OdbcCommand = New OdbcCommand(selectSQL, connection) adapter.SelectCommand = selectCMD
selectCMD.Parameters.Add("@CountryRegion", OdbcType.VarChar, 15).Value = "UK" selectCMD.Parameters.Add("@City", OdbcType.VarChar, 15).Value = "London" Dim customers As DataSet = New DataSet
adapter.Fill(customers, "Customers")
C#
// 変数 connection は、有効な OdbcConnection オブジェクトとする。 OdbcDataAdapter adapter = new OdbcDataAdapter( );
OdbcCommand selectCMD = new OdbcCommand(selectSQL, connection); adapter.SelectCommand = selectCMD;
selectCMD.Parameters.Add("@CountryRegion", OdbcType.VarChar, 15).Value = "UK"; selectCMD.Parameters.Add("@City", OdbcType.VarChar, 15).Value = "London"; DataSet customers = new DataSet( );
adapter.Fill(customers, "Customers");
※ 或るパラメータに対してパラメータ名がサポートされて居ない場合は、Parameter1 から増分して行 く既定名ParameterN が割り当てられる。パラメータ名を指定する時には、ParameterN の名前付 けルールを使用しない事を推奨する。此れは、指定した名前が ParameterCollection 内の既存のパ ラメータ名と競合しない様にする為で有る。指定した名前が既に存在する場合は、例外が発生する。
Parameter.DbType
パラメータの型は、.NET Framework データプロバイダに固有の属性で有る。型が指定されて居る場合 は、其の値がデータソースに渡される前にParameter の値が.NET Framework データプロバイダ型に 変換される。Parameter オブジェクトの DbType プロパティを特定の DbType に設定する一般的な方法 でParameter の型を指定する事も出来る。
Parameter オブジェクトの.NET Framework データプロバイダ型は、Parameter オブジェクトの Value の.NET Framework 型か、又は、Parameter オブジェクトの DbType から推論される。Parameter 値 と仕て渡されるオブジェクト、又は、指定されたDbType に基づいて推論される Parameter 型を、次 の表に示す。
.NET Framework System.Data.DbType SqlDbType OleDbType OdbcType OracleType
bool Boolean Bit Boolean Bit Byte
byte Byte TinyInt UnsignedTinyInt TinyInt Byte
byte[] Binary VarBinary. ※２ VarBinary Binary Raw
char ※１ Char Char Byte
DateTime DateTime DateTime DBTimeStamp DateTime DateTime
Decimal Decimal Decimal Decimal Numeric Number
double Double Float Double Double Double
float Single Real Single Real Float
Guid Guid UniqueIdentifier Guid UniqueIdentifier Raw
Int16 Int16 SmallInt SmallInt SmallInt Int16
Int32 Int32 Int Int Int Int32
Int64 Int64 BitInt BigInt BigInt Number
object Object Variant Variant ※１ Blob
string String NVarChar ※３ VarWChar NVarChar NVarChar
TimeSpan Time ※１ DBTime Time DateTime
UInt16 UInt16 ※１ UnsignedSmallInt Int UInt16
UInt32 UInt32 ※１ UnsignedInt BigInt UInt32
UInt64 UInt64 ※１ UnsignedBigInt Numeric Number
AnsiString VarChar VarChar VarChar VarChar AnsiStringFixedLength Char Char Char Char
Currency Money Currency ※１ Number
Date ※１ DBDate Date DateTime
SByte ※１ TinyInt ※１ SByte
StringFixedLength NChar WChar NChar NChar
Time ※１ DBTime Time DateTime
VarNumeric ※１ VarNumeric ※１ Number
※１ サポートされて居ない。
※２ バイト配列が VarBinary の最大サイズ（8000 バイト）より大きい場合は、此の暗黙の変換はエラ ーに成る。8000 バイトを超えるバイト配列の場合は、明示的に SqlDbType を設定する。 ※３ 文字列が NVarChar の最大サイズ（4000 文字）より大きい場合、此の暗黙の変換はエラーに成る。
※ .NET Framework Version 1.0 に同梱されて居る.NET Framework データプロバイダは、Decimal パラメータ値のPrecision と Scale を確認しない為、切り捨てられたデータがデータソースに挿入さ れる事が有る。.NET Framework Version 1.0 を使用して居る場合は、Decimal 値の Precision と Scale を検証してからパラメータ値を設定する。.NET Framework Version 1.1 以降では、Decimal パラメータ値で無効なPrecision が設定されて居る場合、例外がスローされる。Decimal パラメータ スケールを超えるScale 値は、切り捨てられる。
※ .NET Framework Version 1.0 以降では、System.Data.SqlTypes を System.Data.SqlClient と共に 使用出来る。詳細に付いては、「SqlTypes の使用」を参照され度い。
Parameter.Direction
Parameter の Direction を設定する為に ParameterDirection 列挙型で使用出来る値を次の表に示す。
メンバ名 説明 Input 此のパラメータは入力パラメータで有る（既定値）。 InputOutput 此のパラメータは入力と出力の両方の機能を持って居る。 Output 此のパラメータは出力パラメータで有る。 ReturnValue 此のパラメータは戻り値を表す。 Parameter の Direction を設定する方法を次のコード例に示す。 Visual Basic、C# parameter.Direction = ParameterDirection.Output Parameter.SourceColumn、Parameter.SourceVersion
SourceColumn と SourceVersion は、Parameter コンストラクタに記述子と仕て渡したり、既存の Parameter のプロパティと仕て設定する事も出来る。SourceColumn は、Parameter の値の取得元で 有るDataRow の DataColumn の名前で有る。SourceVersion は、DataAdapter が値を取得する為に使 用するDataRow バージョンを指定する。 SourceVersion で使用出来る DataRowVersion 列挙型の値を次の表に示す。 メンバ名 説明 Current 此のパラメータは列の現在の値を使用する（既定値）。 Default 此のパラメータは列のDefaultValue を使用する。 Original 此のパラメータは列の元の値を使用する。 Proposed 此のパラメータは提示された値を使用する。
CustomerID 列を 2 つの パ ラ メー タ @CustomerID （ SET CustomerID = @CustomerID ） 及び @OldCustomerID（WHERE CustomerID = @OldCustomerID）の SourceColumn と仕て使用する UPDATE ステートメントを定義するコード例を次に示す。@CustomerID パラメータは CustomerID 列をDataRow の現在の値に更新する為に使用されて居る。其の為、SourceVersion を Current に設定 したCustomerID SourceColumn が使用されて居る。@OldCustomerID パラメータは、データソース の現在の行を識別する為に使用されて居る。其の行のOriginal バージョンで一致する列の値が見付かっ た為、SourceVersion を Original に設定した同じ SourceColumn（CustomerID）が使用されて居る。
SqlClient
Visual Basic adapter.UpdateCommand.Parameters.Add( _
"@CustomerID", SqlDbType.NChar, 5, "CustomerID") adapter.UpdateCommand.Parameters.Add( _
"@CompanyName", SqlDbType.NVarChar, 40, "CompanyName") Dim parameter As SqlParameter = _
adapter.UpdateCommand.Parameters.Add("@OldCustomerID", _ SqlDbType.NChar, 5, "CustomerID")
parameter.SourceVersion = DataRowVersion.Original C# adapter.UpdateCommand.Parameters.Add(
"@CustomerID", SqlDbType.NChar, 5, "CustomerID"); adapter.UpdateCommand.Parameters.Add(
"@CompanyName", SqlDbType.NVarChar, 40, "CompanyName"); SqlParameter parameter =
adapter.UpdateCommand.Parameters.Add(
"@OldCustomerID", SqlDbType.NChar, 5, "CustomerID"); parameter.SourceVersion = DataRowVersion.Original; UpdatedRowSource
Command オブジェクトの UpdatedRowSource プロパティを使用すると、データソースから返された 値をDataSet に割り当てる方法を制御出来る。UpdatedRowSource プロパティを UpdateRowSource 列挙型の値の1 つに設定する事で、DataAdapter コマンドが返したパラメータを無視するか、DataSet 内の変更行に適用するかを制御出来る。最初に返された行（存在する場合）を、DataSet 内の変更行に 適用するか何うかを指定する事も出来る。 UpdateRowSource 列挙型の様々の値と、其等の値が DataAdapter で使用されるコマンドの動作に何の 様に影響するかを次の表で説明する。 UpdateRowSource 説明 Both 出力パラメータと返された結果セットの最初の行をDataSet 内の変更行に割り当てる。 FirstReturnedRecord 返された結果セットの最初の行のデータ丈をDataSet 内の変更行に割り当てる。 None 出力パラメータ又は返された結果セットの行が無視される。 OutputParameters 出力パラメータ丈をDataSet 内の変更行に割り当てる。 ■ パラメータと戻り値の指定 ストアドプロシージャには、入力パラメータと出力パラメータの他に戻り値を含める事が出来る。次の 例は、ADO.NET が新しいレコードを、主キー列が SQL Server データベースの ID 列と成って居るテ ーブルに挿入して、入力パラメータ、出力パラメータ、及び、戻り値を受け渡す例を説明して居る。 此の例では、次のストアドプロシージャを使用してNorthwind Categories テーブルに新しいカテゴリ を挿入する。此のストアドプロシージャは、CategoryName 列の値を入力パラメータと仕て受け取り、 SCOPE_IDENTITY 関数を使用して ID フィールド CategoryID の新しい値を取得し、其の値を出力パ
ラメータ内に返す。RETURN ステートメントは、@@ROWCOUNT 関数を使用して、挿入された行の 数を返す。
CREATE PROCEDURE InsertCategory @CategoryName nchar(15),
@Identity int OUTPUT AS
SET NOCOUNT ON
INSERT INTO Categories (CategoryName) VALUES(@CategoryName) SET @Identity = SCOPE_IDENTITY( )
RETURN @@ROWCOUNT
上述のInsertCategory ストアドプロシージャを SqlDataAdapter の InsertCommand のソースと仕て 使用する例を次に示す。@Idenrity 出力パラメータと戻り値は、SqlDataAdapter の Update メソッド が呼び出され、データベースにレコードが挿入された後でDataSet に反映される。
※ OleDbDataAdapter を使用する場合、ReturnValue の ParameterDirection を含むパラメータを他 のパラメータより先に指定する必要が有る。
Visual Basic
' 変数 connection は、有効な SqlConnection オブジェクトとする。 Dim adapter As SqlDataAdapter = New SqlDataAdapter( _
"SELECT CategoryID, CategoryName FROM dbo.Categories", connection) adapter.InsertCommand = New SqlCommand( _
"InsertCategory" , connection)
adapter.InsertCommand.CommandType = CommandType.StoredProcedure Dim parameter As SqlParameter = adapter.InsertCommand.Parameters.Add( _ "@RowCount", SqlDbType.Int)
parameter.Direction = ParameterDirection.ReturnValue adapter.InsertCommand.Parameters.Add( _
"@CategoryName", SqlDbType.NChar, 15, "CategoryName") parameter = adapter.InsertCommand.Parameters.Add( _ "@Identity", SqlDbType.Int, 0, "CategoryID")
parameter.Direction = ParameterDirection.Output Dim categoriesDS As DataSet = New DataSet( ) adapter.Fill(categoriesDS, "Categories")
Dim newRow As DataRow = categoriesDS.Tables("Categories").NewRow( ) newRow("CategoryName") = "New Category"
categoriesDS.Tables("Categories").Rows.Add(newRow) adapter.Update(categoriesDS, "Categories")
Dim rowCount As Int32 = _
C#
// 変数 connection は、有効な SqlConnection オブジェクトとする。 SqlDataAdapter adapter = new SqlDataAdapter(
"SELECT CategoryID, CategoryName FROM dbo.Categories", connection); adapter.InsertCommand = new SqlCommand("InsertCategory", connection); adapter.InsertCommand.CommandType = CommandType.StoredProcedure; SqlParameter parameter = adapter.InsertCommand.Parameters.Add( "@RowCount", SqlDbType.Int);
parameter.Direction = ParameterDirection.ReturnValue; adapter.InsertCommand.Parameters.Add(
"@CategoryName", SqlDbType.NChar, 15, "CategoryName"); parameter = adapter.InsertCommand.Parameters.Add(
"@Identity", SqlDbType.Int, 0, "CategoryID"); parameter.Direction = ParameterDirection.Output; DataSet categoriesDS = new DataSet( );
adapter.Fill(categoriesDS, "Categories");
DataRow newRow = categoriesDS.Tables["Categories"].NewRow( ); newRow["CategoryName"] = "New Category";
categoriesDS.Tables["Categories"].Rows.Add(newRow); adapter.Update(categoriesDS, "Categories");
Int32 rowCount = (Int32)adapter.InsertCommand.Parameters["@RowCount"].Value; ■ DataAdapter に依るバッチ更新の実行 以前のバージョンのADO.NET では、DataSet に格納されて居る変更内容をデータベースに反映する場 合、DataAdapter の Update メソッドを実行して、1 行宛データベースを更新して居た。此のメソッド は、指定されたDataTable 内の行を反復処理すると、各 DataRow を調べ、行が変更された事を確認す る。行が変更されて居る場合、其の行のRowState プロパティの値に基づいて、適切な UpdateCommand、 InsertCommand、又は、DeleteCommand の孰れかを呼び出す。各行の更新では、データベースへの ネットワークラウンドトリップが発生する。
ADO.NET 2.0 で は 、 UpdateBatchSize プ ロ パ テ ィ が DataAdapter に 依 っ て 公 開 さ れ る 。 UpdateBatchSize を正の整数値に設定すると、データベースの更新が指定されたサイズのバッチと仕て 送信される。例えば、UpdateBatchSize を 10 に設定すると、10 個の個別のステートメントがグループ 化され、単一のバッチと仕て送信される。UpdateBatchSize を 0 に設定すると、DataAdapter は、サ ーバーが処理出来る最大のバッチサイズを使用する。1 に設定すると、バッチ更新が無効に成り、1 行 宛送信される。 サイズの大きいバッチを実行すると、パフォーマンスが低下する可能性が有る。其の為、アプリケーシ ョンを実装する前に、バッチの最適なサイズ設定をテストする必要が有る。 UpdateBatchSize プロパティの使用 バッチ更新を有効にする場合、DataAdapter の UpdateCommand、InsertCommand、DeleteCommand
のUpdatedRowSource プロパティ値を、None か OutputParameters に設定する必要が有る。バッチ 更新を実行する際、FirstReturnedRecord 又は Both のコマンドの UpdatedRowSource プロパティ値 は、無効に成る。
UpdateBatchSize プロパティを使用するプロシージャを次に示す。此のプロシージャは、2 つの引数を 取る。1 つは、Production.ProductCategory テーブル内の ProductCategoryID フィールドと Name フ ィールドを表す列を持つDataSet オブジェクトで、今 1 つは、バッチサイズ（バッチファイル内の行数） を表す整数で有る。此のコードに依り、新しい SqlDataAdapter オブジェクトが作成され、其の UpdateCommand プロパティ、InsertCommand プロパティ、DeleteCommand プロパティが設定され る。此のコードは、DataSet オブジェクトに依って行が変更済みに成って居る事を前提と仕て居る。此 のオブジェクトは、UpdateBatchSize プロパティを設定し、更新を実行する。
Visual Basic
Public Sub BatchUpdate(ByVal dataTable As DataTable, ByVal batchSize As Int32) ' 関数 GetConnectionString が、有効な接続文字列を返す物とする。
Dim connectionString As String = GetConnectionString( )
' AdventureWorks データベースに接続
Using connection As New SqlConnection(connectionString) ' SqlDataAdapter の生成
Dim adapter As New SqlDataAdapter( )
' UPDATE コマンドとパラメータの設定
adapter.UpdateCommand = New SqlCommand( _ "UPDATE Production.ProductCategory SET " & _
"Name=@Name WHERE ProductCategoryID=@ProdCatID;", connection) adapter.UpdateCommand.Parameters.Add("@Name", _ SqlDbType.NVarChar, 50, "Name") adapter.UpdateCommand.Parameters.Add("@ProdCatID", _ SqlDbType.Int, 4, " ProductCategoryID ") adapter.UpdateCommand.UpdatedRowSource = _ UpdateRowSource.None ' INSERT コマンドとパラメータの設定
adapter.InsertCommand = New SqlCommand( _
"INSERT INTO Production.ProductCategory (Name) VALUES (@Name);", connection) adapter.InsertCommand.Parameters.Add("@Name", _
SqlDbType.NVarChar, 50, "Name")
adapter.InsertCommand.UpdatedRowSource = _ UpdateRowSource.None
' DELETE コマンドとパラメータの設定
adapter.DeleteCommand = New SqlCommand( _ "DELETE FROM Production.ProductCategory " & _ "WHERE ProductCategoryID=@ProdCatID;", connection) adapter.DeleteCommand.Parameters.Add("@ProdCatID", _ SqlDbType.Int, 4, " ProductCategoryID ") adapter.DeleteCommand.UpdatedRowSource = UpdateRowSource.None ' バッチサイズの設定 adapter.UpdateBatchSize = batchSize ' Update の実行 adapter.Update(dataTable) End Using
C#
public static void BatchUpdate(DataTable dataTable,Int32 batchSize) {
// 関数 GetConnectionString が、有効な接続文字列を返す物とする。 string connectionString = GetConnectionString( );
// AdventureWorks データベースに接続
using (SqlConnection connection = new SqlConnection(connectionString)) {
// SqlDataAdapter の生成
SqlDataAdapter adapter = new SqlDataAdapter( );
// UPDATE コマンドとパラメータの設定
adapter.UpdateCommand = new SqlCommand( "UPDATE Production.ProductCategory SET "
+ "Name=@Name WHERE ProductCategoryID=@ProdCatID;", connection); adapter.UpdateCommand.Parameters.Add("@Name", SqlDbType.NVarChar, 50, "Name"); adapter.UpdateCommand.Parameters.Add("@ProdCatID", SqlDbType.Int, 4, "ProductCategoryID"); adapter.UpdateCommand.UpdatedRowSource = UpdateRowSource.None; // INSERT コマンドとパラメータの設定
adapter.InsertCommand = new SqlCommand(
"INSERT INTO Production.ProductCategory (Name) VALUES (@Name);", connection); adapter.InsertCommand.Parameters.Add("@Name",
SqlDbType.NVarChar, 50, "Name");
adapter.InsertCommand.UpdatedRowSource = UpdateRowSource.None; // DELETE コマンドとパラメータの設定
adapter.DeleteCommand = new SqlCommand( "DELETE FROM Production.ProductCategory "
+ "WHERE ProductCategoryID=@ProdCatID;", connection); adapter.DeleteCommand.Parameters.Add("@ProdCatID", SqlDbType.Int, 4, "ProductCategoryID"); adapter.DeleteCommand.UpdatedRowSource = UpdateRowSource.None; // バッチサイズの設定 adapter.UpdateBatchSize = batchSize; // Update の実行 adapter.Update(dataTable); } } ■ DataAdapter に依るデータソースの更新
DataAdapter の Update メソッドを呼び出して、変更を DataSet からデータソースに反映する。Update メソッドは、Fill メソッドと同様に、引数と仕て DataSet のインスタンス、及び、オプションの DataTable オブジェクト、又は、DataTable 名を受け取る。DataSet のインスタンスは、行われた変更点を格納す るDataSet で有る。DataTable は、変更点の取得元のテーブルで有る。
Update メソッドを呼び出すと、DataAdapter は、既に加えられた変更を解析し、適切なコマンド （INSERT、UPDATE、又は、DELETE）を実行する。DataAdapter は、DataRow へ加えられた変更 を検出すると、InsertCommand、UpdateCommand、又は、DeleteCommand を使用して其の変更を
処理する。其の結果、デザイン時にコマンド構文を指定し、可能な場合はストアドプロシージャを使用 する事に依り、ADO.NET アプリケーションのパフォーマンスを最適化出来る。コマンドは Update を 呼び出す前に明示的に設定する必要が有る。Update を呼び出し、其の更新に関連する適切なコマンド が存在しない場合（例えば、削除済みの行に関連するDeleteCommand が存在しない場合）は、例外が スローされる。 Command パラメータを使用して、DataSet 内の各変更行に対する SQL ステートメントやストアドプ ロシージャに入力値と出力値を指定出来る。詳細に付いては、「DataAdapter に依るパラメータの使用」 を参照され度い。 DataTable を単一データベーステーブルに割り当てたり、単一データベースから生成する場合は、 DbCommandBuilder オ ブ ジ ェ ク ト を 利 用 し て 自 動 的 に DataAdapter の DeleteCommand 、 InsertCommand、及び、UpdateCommand を生成出来る。詳細に付いては、「コマンドの自動生成」 を参照され度い。
Update メソッドは変更点を元のデータソースに反映させるが、DataSet に最後にデータを格納した後、 他のクライアントがデータソースのデータを変更した可能性も有る。DataSet を現在のデータで更新す るには、DataAdapter、及び、Fill メソッドを使用する。新しい行がテーブルに追加され、更新された 情報が既存の行に取り込まれる。Fill メソッドは、DataSet の行と SelectCommand に依って返された 行の主キーの値を調べて、新しい行が追加されたか、又は、既存の行が更新されたかを判断する。Fill メソッドは、SelectCommand に依って返された結果の行に一致する主キーの値を持つ DataSet の行を
見付けた場合、SelectCommand に依って返された行の情報で既存の行を更新して、既存の行の
RowState を Unchanged に設定する。SelectCommand に依って返された行の主キーの値が、DataSet の何の行の主キーの値にも一致しない場合、Fill メソッドは、RowState が Unchanged の新しい行を追 加する。
※ SelectCommand が OUTER JOIN の結果を返す場合、DataAdapter は、生成される DataTable に PrimaryKey 値を設定しない。自分で PrimaryKey を定義して、重複行が正しく反映される様にす る必要が有る。詳細に付いては、「テーブルの主キーの定義」を参照され度い。 Update メソッド呼出時に発生する例外を処理するには、行更新エラーが発生した時に RowUpdated イ ベントを使用して応答するか（「DataAdapter イベントの使用」を参照）、又は、Update メソッド呼出 の前に DataAdapter.ContinueUpdateOnError を true に設定し、更新が完了した時点で特定の行の RowError プロパティに格納されて居るエラー情報に応答する（「行のエラー情報の追加と読み取り」を 参照）。
※ DataSet、DataTable、又は、DataRow に対して AcceptChanges を呼び出すと、DataRow の総て のOriginal 値が DataRow の Current 値で上書きされる。行を一意に識別するフィールド値が変更 された場合は、AcceptChanges 呼出の後、Original 値はデータソースの値と一致しなく成る。 DataAdapter の UpdateCommand を明示的に設定して、変更済みの行に対して更新を実行する方法を 次の例に示す。UPDATE ステートメントの WHERE 句に指定したパラメータが SourceColumn の Original 値を使用する様に設定されて居る事に注意され度い。Current 値が既に変更されて居る可能性、 然して、データソースの値と一致して居ない可能性が有る為、此の設定は重要で有る。Original 値は、 データソースからDataTable にデータを取得する為に使用された値で有る。
Visual Basic
' 変数 connection は、有効な SqlConnection オブジェクトとする。 Dim adapter As SqlDataAdapter = New SqlDataAdapter( _
adapter.UpdateCommand = New SqlCommand( _
"UPDATE Categories SET CategoryName = @CategoryName " & _ "WHERE CategoryID = @CategoryID", connection)
adapter.UpdateCommand.Parameters.Add( _
"@CategoryName", SqlDbType.NVarChar, 15, "CategoryName")
Dim parameter As SqlParameter = adapter.UpdateCommand.Parameters.Add( _ "@CategoryID", SqlDbType.Int)
parameter.SourceColumn = "CategoryID"
parameter.SourceVersion = DataRowVersion.Original Dim dataSet As DataSet = New DataSet
adapter.Fill(dataSet, "Categories")
Dim row As DataRow = dataSet.Tables("Categories").Rows(0) row("CategoryName") = "New Category"
adapter.Update(dataSet, "Categories")
C#
// 変数 connection は、有効な SqlConnection オブジェクトとする。 SqlDataAdapter dataAdpater = new SqlDataAdapter(
"SELECT CategoryID, CategoryName FROM Categories", connection); dataAdpater.UpdateCommand = new SqlCommand(
"UPDATE Categories SET CategoryName = @CategoryName " + "WHERE CategoryID = @CategoryID" , connection);
dataAdpater.UpdateCommand.Parameters.Add(
"@CategoryName", SqlDbType.NVarChar, 15, "CategoryName");
SqlParameter parameter = dataAdpater.UpdateCommand.Parameters.Add( "@CategoryID", SqlDbType.Int);
parameter.SourceColumn = "CategoryID";
parameter.SourceVersion = DataRowVersion.Original; DataSet dataSet = new DataSet( );
dataAdpater.Fill(dataSet, "Categories");
DataRow row = dataSet.Tables["Categories"].Rows[0]; row ["CategoryName"] = "New Category";
dataAdpater.Update(dataSet, "Categories"); AutoIncrement 列
データソースからのテーブルに自動インクリメント列が有る場合、DataSet の列に値を格納するには、 自動インクリメント値をストアドプロシージャの出力パラメータと仕て返して其れをテーブルの列に 割り当てるか、又は、DataAdapter の RowUpdated イベントを使用する。此の例に付いては、「ID 値 とAutonumber 値の取得」を参照され度い。
但し、DataSet 内の値はデータソースの値と同期しなく成る為、予期しない動作を発生する場合が有る。 例えば、CustomerID と謂う自動インクリメント主キー列を持つテーブルが有るとする。DataSet 内に
