データアダプタ詳細

Transcription

1 データベース 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 AcceptChangesDuringUpdate Container 説明 Fill 操作中に DataTable に DataRow が追加された後で 其の行に対して AcceptChanges を呼び出すか何うかを示す値を取得 設定する Update で AcceptChanges が呼び出されるか何うかを取得 設定する Component を格納して居る IContainer を取得する -1-

2 ContinueUpdateOnError FillLoadOption MissingMappingAction MissingSchemaAction ReturnProviderSpecificTypes Site TableMappings 行の更新中にエラーが発生した時に 例外を生成するか何うかを指定する値を取得 設定する アダプタが DbDataReader から DataTable にデータを読み込む方法を決定する LoadOption を取得 設定する 一致するテーブルや列が受信データに含まれて居ない場合に実行するアクションを決定する 既存の DataSet スキーマが受信データと一致しない時に実行するアクションを決定する Fill メソッドがプロバイダ固有の値 又は 共通の CLS 準拠の値の孰れを返すかを取得 設定する Component の ISite を取得 設定する ソーステーブルと 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 ステートメントを個別に呼び出す -2-

3 プロテクトメソッド 名前 CloneInternals CreateTableMappings Dispose Fill FillSchema Finalize GetService HasTableMappings MemberwiseClone OnFillError ShouldSerializeTableMappings 説明此の DataAdapter のインスタンスのコピーを作成する 新しい DataTableMappingCollection を作成する DataAdapter に依って使用されて居るリソースを解放する DataSet 名を使用して データソース内の行と一致する様に DataSet 内の行を追加 更新する 亦 DataTable を作成する DataTable を指定した DataSet に追加する Component がガベージコレクションに依ってクリアされる前に アンマネージリソースを解放し 其の他のクリーンアップ操作を実行する Component や其の Container で提供されるサービスを表すオブジェクトを返す DataTableMappingCollection が作成されて居るか何うかを示す Fill 中にエラーが発生した時に呼び出される 1 つ以上の DataTableMapping オブジェクトが存在し 其等を永続化する必要が有るか何うかを確認する パブリックイベント 名前 Disposed FillError 説明 コンポーネントの Disposed イベントを待機するイベントハンドラを追加する 格納操作中にエラーが発生した時に返される -3-

4 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 に依るデータソースの更新 で更に詳しく説明する -4-

5 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 プロパティを作成する為に使用される ' 変数 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") // 変数 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 メソッドを呼び出す事でアプリケーションのパフォーマンスを改善出来る リソースを解放して他のクライアントアプリケーションが使用出来る様にする為に データソースへの接続を開いた儘にする時間は最小限にする事を推奨する -5-

6 複数結果セット 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 オブジェクトの詳細に付いては テーブル間のリレーションシップの追加 及び テーブル間のリレーションシップの移動 を参照され度い ' 変数 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 Next -6-

7 // 変数 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 にチャプタ列の名前と一致するテーブルが既に存在する場合は 現在のテーブルにチャプタデータが格納される 既存のテーブルにチャプタ内の列と一致する列が存在しない場合は 新しい列が追加される -7-

8 DataSet 内のテーブルにチャプタ列のデータを格納する前に 親テーブルと子テーブルの両方に 1 つの整数列を追加し 親列を自動インクリメントに設定し 両方のテーブルに追加された列を使用して DataRelation を作成すると 階層構造の行セットを形成して居る親テーブルと子テーブルの間にリレーションが作成される 追加されたリレーションには親テーブルの名前とチャプタ列の名前を使用した "ParentTableNameChapterColumnName" 形式の名前が割り当てられる 関連付けられた列は DataSet 丈に存在する 其のデータソースからの次の Fill 操作を実行すると 変更を既存の行にマージするのではなく テーブルに新しい行が追加される DataTable を受け取る DataAdapter.Fill オーバーロードを使用した場合は 其のテーブル丈にデータが格納される 自動インクリメント整数列は 引き続き其のテーブルに追加されるが 子テーブルの作成 子テーブルへのデータの格納 及び リレーションの作成は行われない MSDataShape プロバイダを使用して顧客リスト内の各顧客に対応するオーダー列を生成する例を次に示す チャプタ列を生成した後で 1 つの DataSet 内に其のデータを格納する 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 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 が作成される サンプル結果の一部を次の表に示す -8-

9 TableName:Customers CustomerID CompanyName Orders ALFKI Alfreds Futterkiste 0 ANATR Ana Trujillo Emparedados y helados 1 TableName:CustomersOrders CustomerID OrderID CustomersOrders ALFKI ALFKI ANATR ANATR クエリ結果のページング クエリ結果のページングとは クエリ結果をデータの小さなサブセット 詰まり ページに分けて返すプロセスで有る クエリ結果のページングは 結果を管理し易い小さな単位でユーザーに表示する為に行われる一般的な処理で有る DataAdapter には Fill メソッドのオーバーロードを通じて 1 ページ分のデータ丈を返す機能が用意されて居る 併し 此れは大きなクエリ結果のページングには適して居ない DataAdapter が目的の DataTable 又は DataSet に 要求されたレコード丈を格納する一方で クエリ全体を返す為のリソースが使用される為で有る クエリ全体を返す必要が有るリソースを使用せずにデータソースから 1 ページ分のデータを返すには 必要な行丈返す様に限定する抽出条件をクエリに追加する Fill メソッドを使用して 1 ページ分のデータを返すには データページの先頭レコードを指定する startrecord パラメータとデータページのレコード数を指定する maxrecords パラメータを指定する Fill メソッドを使用してクエリ結果の最初のページ ( ページサイズ :5 つのレコード ) を返す方法を次のコード例に示す 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") 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( ); adapter.fill(dataset, currentindex, pagesize, "Orders"); -9-

10 上記の例では DataSet に 5 つのレコード丈が格納されるが Orders テーブル全体が返される DataSet に此れと同じ 5 つのレコードを格納し 5 つのレコード丈を返すには 次のコード例に示す様に SQL ステートメントで TOP 句と WHERE 句を使用する 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") 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 を渡す為に 行を順序付けする固有の識別子を保存する必要が有る 次のコード例で示す Dim lastrecord As String = _ dataset.tables("orders").rows(pagesize - 1)("OrderID").ToString( ) string lastrecord = dataset.tables["orders"].rows[pagesize - 1]["OrderID"].ToString( ); startrecord パラメータと maxrecords パラメータを受け取る Fill メソッドのオーバーロードを使用して次のレコードページを返すには 現在のレコードインデックスをページサイズの分丈インクリメントし テーブルにレコードページを格納する DataSet に 1 ページ分のレコード丈を追加する場合でも データベースサーバーはクエリ結果全体を返す事に注意され度い 次のデータページを格納する前にテーブル行をクリアするコード例を次に示す データベースサーバーとの遣り取りを減らす為に ローカルのキャッシュに 返された一定数の行を保存する事も出来る currentindex = currentindex + pagesize dataset.tables("orders").rows.clear( ) adapter.fill(dataset, currentindex, pagesize, "Orders") currentindex += pagesize; dataset.tables["orders"].rows.clear( ); adapter.fill(dataset, currentindex, pagesize, "Orders"); -10-

11 データベースサーバーに依ってクエリ全体を返さずに次のレコードページを返すには SELECT ステートメントに限定的な抽出条件を指定する 上の例では最後に返されたレコードが保存されるが 次のコード例に示す様に其のレコードを WHERE 句で使用するとクエリの開始点を指定出来る 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") 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 を作成する例を次に示す workadapter.tablemappings.add("authorsmapping", "Authors") 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 テーブルに有る より解り易い名前のセットに割り当てる 割り当てられない列には データソースの列名が使用される 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) -11-

12 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 に割り当てゝ居る 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") 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 内のテーブルマップ名と競合しない様にする為で有る 指定した名前が既に存在する場合は 例外がスローされる -12-

13 複数結果セット SelectCommand が複数のテーブルを返す場合 Fill は DataSet 内のテーブルに対するインクリメント値を含むテーブル名を自動的に生成する 此れは 指定したテーブル名で開始し TableNameN の形式で TableName1 から数値を加算して行く名前に成る 自動的に生成されたテーブル名は テーブルの割り当てを使用して DataSet 内でテーブルに指定する名前に変換出来る 例えば Customers と Orders と謂う 2 つのテーブルを返す SelectCommand に対して 次の Fill 呼出を実行する adapter.fill(customersdataset, "Customers") DataSet 内に Customers と Customers1 と謂う 2 つのテーブルが作成される テーブルマップを使用して 2 つ目のテーブルに Customers1 と謂う名前の代わりに Orders と謂う名前を付ける事が出来る 其れには 次の例に示す様に ソーステーブル Customers1 を DataSet テーブル Orders に割り当てる 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 WHERE CustomerID パラメータのプレースホルダの構文は データソースに依って異なる 次に SQL Server のデータソースのプレースホルダの例を示す System.Data.OleDb パラメータと System.Data.Odbc パラメータのプレースホルダと仕て 疑問符 (? ) を使用する 此の の例では CompanyName フィールドは CustomerID パラメータの値で更新される 此等のパラメータは SqlParameter オブジェクトの SourceColumn プロパティを使用して 変更された行から情報を取得する 前のサンプル UPDATE ステートメントのパラメータを次に示す 此のコードは 変数 adapter が有効な SqlDataAdapter オブジェクトを表す事を前提と仕て居る -13-

14 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 パラメータの SourceVersion が Original に設定されて居る事に注意され度い 此の設定に依り 変更済みの DataRow の中で 識別を行う 1 つ 又は 複数の列の値が既に変更されて居る場合に データソース内の既存の行を更新する事を保証出来る 識別列の値が既に変更されて居る場合は Original 行の値はデータソースの現在の値と一致し Current パラメータの SourceVersion は設定されて居ない為 既定の Current の行の値が使用される SqlClient の例 SQL ステートメントを SqlDataAdapter の SelectCommand InsertCommand UpdateCommand DeleteCommand の各プロパティの CommandText と仕て使用する例を次に示す SqlDataAdapter オブジェクトの場合は 名前付きのパラメータを使用する必要が有る 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 string selectsql = "SELECT CustomerID, CompanyName FROM Customers WHERE CountryRegion = " + "@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 OleDb 又は Odbc の例 OleDbDataAdapter オブジェクトと OdbcDataAdapter オブジェクトの場合は 疑問符 (? ) のプレースホルダを使用してパラメータを識別する必要が有る -14-

15 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 =?" 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 ' 変数 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") // 変数 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( ); adapter.fill(customers, "Customers"); -15-

16 OleDb ' 変数 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") // 変数 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 ' 変数 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") // 変数 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 内の既存のパラメータ名と競合しない様にする為で有る 指定した名前が既に存在する場合は 例外が発生する -16-

17 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. 2 VarBinary Binary Raw char 1 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 1 Blob string String NVarChar 3 VarWChar NVarChar NVarChar TimeSpan Time 1 DBTime Time DateTime UInt16 UInt16 1 UnsignedSmallInt Int UInt16 UInt32 UInt32 1 UnsignedInt BigInt UInt32 UInt64 UInt64 1 UnsignedBigInt Numeric Number AnsiString VarChar VarChar VarChar VarChar AnsiStringFixedLength Char Char Char Char Currency Money Currency 1 Number Date 1 DBDate Date DateTime SByte 1 TinyInt 1 SByte StringFixedLength NChar WChar NChar NChar Time 1 DBTime Time DateTime VarNumeric 1 VarNumeric 1 Number 1 サポートされて居ない 2 バイト配列が VarBinary の最大サイズ (8000 バイト ) より大きい場合は 此の暗黙の変換はエラーに成る 8000 バイトを超えるバイト配列の場合は 明示的に SqlDbType を設定する 3 文字列が NVarChar の最大サイズ (4000 文字 ) より大きい場合 此の暗黙の変換はエラーに成る 4000 文字を超える文字列の場合は 明示的に SqlDbType を設定する -17-

18 .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 を設定する方法を次のコード例に示す 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 ) CustomerID の SourceColumn と仕て使用する UPDATE パラメータは CustomerID 列を DataRow の現在の値に更新する為に使用されて居る 其の為 SourceVersion を Current に設定した CustomerID SourceColumn パラメータは データソースの現在の行を識別する為に使用されて居る 其の行の Original バージョンで一致する列の値が見付かった為 SourceVersion を Original に設定した同じ SourceColumn(CustomerID) が使用されて居る -18-

19 SqlClient 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 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 FirstReturnedRecord None OutputParameters 説明出力パラメータと返された結果セットの最初の行を DataSet 内の変更行に割り当てる 返された結果セットの最初の行のデータ丈を DataSet 内の変更行に割り当てる 出力パラメータ又は返された結果セットの行が無視される 出力パラメータ丈を DataSet 内の変更行に割り当てる パラメータと戻り値の指定 ストアドプロシージャには 入力パラメータと出力パラメータの他に戻り値を含める事が出来る 次の例は ADO.NET が新しいレコードを 主キー列が SQL Server データベースの ID 列と成って居るテーブルに挿入して 入力パラメータ 出力パラメータ 及び 戻り値を受け渡す例を説明して居る 此の例では 次のストアドプロシージャを使用して Northwind Categories テーブルに新しいカテゴリを挿入する 此のストアドプロシージャは CategoryName 列の値を入力パラメータと仕て受け取り SCOPE_IDENTITY 関数を使用して ID フィールド CategoryID の新しい値を取得し 其の値を出力パ -19-

20 ラメータ内に返す RETURN ステートメントは 関数を使用して 挿入された行の数を返す CREATE PROCEDURE int OUTPUT AS SET NOCOUNT ON INSERT INTO Categories (CategoryName) = SCOPE_IDENTITY( ) 上述の InsertCategory ストアドプロシージャを SqlDataAdapter の InsertCommand 出力パラメータと戻り値は SqlDataAdapter の Update メソッドが呼び出され データベースにレコードが挿入された後で DataSet に反映される OleDbDataAdapter を使用する場合 ReturnValue の ParameterDirection を含むパラメータを他のパラメータより先に指定する必要が有る ' 変数 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 = _ CInt(adapter.InsertCommand.Parameters("@RowCount").Value) -20-

21 // 変数 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 -21-

22 の UpdatedRowSource プロパティ値を None か OutputParameters に設定する必要が有る バッチ更新を実行する際 FirstReturnedRecord 又は Both のコマンドの UpdatedRowSource プロパティ値は 無効に成る UpdateBatchSize プロパティを使用するプロシージャを次に示す 此のプロシージャは 2 つの引数を取る 1 つは Production.ProductCategory テーブル内の ProductCategoryID フィールドと Name フィールドを表す列を持つ DataSet オブジェクトで 今 1 つは バッチサイズ ( バッチファイル内の行数 ) を表す整数で有る 此のコードに依り 新しい SqlDataAdapter オブジェクトが作成され 其の UpdateCommand プロパティ InsertCommand プロパティ DeleteCommand プロパティが設定される 此のコードは DataSet オブジェクトに依って行が変更済みに成って居る事を前提と仕て居る 此のオブジェクトは UpdateBatchSize プロパティを設定し 更新を実行する 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 End Sub -22-

23 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 を使用して其の変更を -23-

24 処理する 其の結果 デザイン時にコマンド構文を指定し 可能な場合はストアドプロシージャを使用する事に依り 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 にデータを取得する為に使用された値で有る ' 変数 connection は 有効な SqlConnection オブジェクトとする Dim adapter As SqlDataAdapter = New SqlDataAdapter( _ "SELECT CategoryID, CategoryName FROM Categories", connection) -24-

25 adapter.updatecommand = New SqlCommand( _ "UPDATE Categories SET CategoryName " & _ "WHERE 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") // 変数 connection は 有効な SqlConnection オブジェクトとする SqlDataAdapter dataadpater = new SqlDataAdapter( "SELECT CategoryID, CategoryName FROM Categories", connection); dataadpater.updatecommand = new SqlCommand( "UPDATE Categories SET CategoryName " + "WHERE 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 内に -25-

26 新しい 2 人の顧客を追加した場合 此等の顧客は自動インクリメント CustomerId 値 1 と 2 を受け取る 2 行目の顧客行が DataAdapter の Update メソッドに渡されると 新しく追加された行は データソースで自動インクリメント CustomerID 値 1 を受け取る 此れは DataSet 内の値 2 とは一致しない DataAdapter が DataSet の行に戻り値を設定すると 1 行目の顧客行が既に CustomerID 値と仕て 1 を持つ為制約違反が発生する 此の様な動作を防ぐには データソースの自動インクリメント列と DataSet の自動インクリメント値を使用する時に AutoIncrementStep を -1 AutoIncrementSeed を 0 に設定して DataSet に列を作成し 同時に 1 から始まり正のステップ値でインクリメントする自動インクリメント ID 値がデータソースで生成される様にする 其の結果 DataSet では自動インクリメント値と仕て負の数値が生成される為 データソースで生成される正の自動インクリメント値と矛盾しなく成る 今 1 つの方法は 自動インクリメント列の代わりに Guid 型の列を使用する事で有る Guid 値生成のアルゴリズムでは データソースで生成される Guid と同じ Guid が DataSet で生成される事は無い DataTable の列を定義する方法の詳細に付いては DataTable のスキーマの定義 を参照され度い 挿入 更新 削除の順序 通常の条件下では DataSet を使用して行う変更の順序をデータソースに送信する事が重要で有る 例えば 既存の行の主キーの値を更新し 其の新しい主キーの値で新しい行を追加する場合 更新は挿入の前に処理する必要が有る DataTable の Select メソッドを使用すると 特定の RowState を持つ行丈を参照する DataRow 配列を返す事が出来る 其の後で 返された DataRow 配列を DataAdapter の Update メソッドに渡して変更行を処理出来る 更新する行のサブセットを指定する事で 挿入 更新 削除の処理順序を制御出来る 例えば次のコードでは テーブルの削除行を最初に処理し 次に更新行 最後に挿入行を処理する Dim table As DataTable = dataset.tables("customers") ' 最初に削除を処理 dataset.update(table.select(nothing, Nothing, _ DataViewRowState.Deleted)) ' 次に更新を処理 adapter.update(table.select(nothing, Nothing, _ DataViewRowState.ModifiedCurrent)) ' 最後に挿入を処理 dataadpater.update(table.select(nothing, Nothing, _ DataViewRowState.Added)) DataTable table = dataset.tables["customers"]; // 最初に削除を処理 adapter.update(table.select(null, null, DataViewRowState.Deleted)); // 次に更新を処理 adapter.update(table.select(null, null, DataViewRowState.ModifiedCurrent)); // 最後に挿入を処理 adapter.update(table.select(null, null, DataViewRowState.Added)); -26-

27 DataAdapter に依る UDT 列の更新 ユーザー定義型 (UDT) に依り DataSet と SqlDataAdapter を使用したデータの取得や変更がサポートされて居る データセットの読み込み Transact-SQL の SELECT ステートメントを使用する事で UDT 列の値を選択してデータアダプタを使用し データセットを読み込む事が出来る 次の例では 以下に示す構造とサンプルデータで Points テーブルが定義されて居る事を前提と仕て居る 次の Transact-SQL ステートメントに依って Points テーブルが作成され 数行が挿入される CREATE TABLE dbo.points (id int PRIMARY Key, p Point); INSERT INTO dbo.points VALUES (1, CONVERT(Point, '1,3')); INSERT INTO dbo.points VALUES (2, CONVERT(Point, '2,4')); INSERT INTO dbo.points VALUES (3, CONVERT(Point, '3,5')); INSERT INTO dbo.points VALUES (4, CONVERT(Point, '4,6')); GO 次に示す ADO.NET コードでは 有効な接続文字列が取得され 新しい SqlDataAdapter が作成され Points テーブルからのデータ行が DataTable に読み込まれる Dim da As New SqlDataAdapter( _ "SELECT id, p FROM dbo.points", connectionstring) Dim dattable As New DataTable("Points") da.fill(dattable) SqlDataAdapter da = new SqlDataAdapter( "SELECT id, p FROM dbo.points", connectionstring); DataTable dattable = new DataTable("Points"); da.fill(dattable); データセットでの UDT データの更新 DataSet で UDT 列を更新するには 次の 2 つの方法が有る SqlDataAdapter オブジェクトに カスタムの InsertCommand UpdateCommand DeleteCommand オブジェクトを指定する コマンドビルダ (SqlCommandBuilder) を使用する事で INSERT UPDATE DELETE コマンドが自動的に作成される 競合を検出するには timestamp 列 ( エイリアス rowversion) を UDT を含む SQL Server テーブルに追加する timestamp データ型は テーブル内の行のバージョンスタンプ用に使用され データベース内で一意で有る事が保証される 此れに依って テーブル内の各行に付いて自動的に生成された 8 バイトの 2 進数が公開され テーブル内の値が変更された場合に自動的に更新される 但し SqlCommandBuilder では 基に成るテーブル内に timestamp 列が存在しない限り 競合の検出に付いて UDT は考慮されない 各 UDT が同等でない事が有る為 コマンドの生成に "compare original values" オプションが使用される場合は WHERE 句には UDT が含まれない -27-

28 次の例では Point UDT 列と timestamp 列を含む 2 番目のテーブルを作成する必要が有る 両方のテーブルを使用して カスタムコマンドオブジェクトを作成してデータを更新する方法と timestamp 列を使用して更新する方法を示す 次の Transact-SQL ステートメントを実行して 2 番目のテーブルを作成し サンプルデータを読み込む CREATE TABLE dbo.points_ts (id int PRIMARY KEY, p Point, ts timestamp); INSERT INTO dbo.points_ts (id, p) VALUES (1, CONVERT(Point, '1,3')); INSERT INTO dbo.points_ts (id, p) VALUES (2, CONVERT(Point, '2,4')); INSERT INTO dbo.points_ts (id, p) VALUES (3, CONVERT(Point, '3,5')); INSERT INTO dbo.points_ts (id, p) VALUES (4, CONVERT(Point, '4,6')); 次の ADO.NET の例には 2 つのメソッドが有る UserProvidedCommands は InsertCommand UpdateCommand DeleteCommand オブジェクトを作成して Points テーブル (timestamp 列を含まない ) の Point UDT を更新する方法を示す CommandBuilder は timestamp 列を含む Points_ts テーブルで SqlCommandBuilder を使用する方法を示す Imports System Imports System.Data Imports System.Data.SqlClient Module Module1 ' 接続文字列の取得 Private connstring As String = GetConnectionString( ) Sub Main( ) UserProvidedCommands( ) CommandBuilder( ) End Sub Private Sub UserProvidedCommands( ) ' 新しい SqlDataAdapter の生成 Dim da As New SqlDataAdapter( "SELECT id, p FROM dbo.points", connstring) ' INSERT/UPDATE/DELETE コマンドの設定 Dim idparam As SqlParameter Dim pointparam As SqlParameter da.insertcommand = New SqlCommand( _ "INSERT INTO dbo.points (id, p) VALUES da.selectcommand.connection) idparam = da.insertcommand.parameters.add("@id", SqlDbType.Int) idparam.sourcecolumn = "id" pointparam = da.insertcommand.parameters.add("@p", SqlDbType.Udt) pointparam.sourcecolumn = "p" pointparam.udttypename = "dbo.point" da.updatecommand = New SqlCommand( _ "UPDATE dbo.points SET p WHERE id da.selectcommand.connection) idparam = da.updatecommand.parameters.add("@id", SqlDbType.Int) -28-

29 idparam.sourcecolumn = "id" pointparam = da.updatecommand.parameters.add("@p", SqlDbType.Udt) pointparam.sourcecolumn = "p" pointparam.udttypename = "dbo.point" da.deletecommand = New SqlCommand( _ "DELETE dbo.points WHERE id da.selectcommand.connection) idparam = da.deletecommand.parameters.add("@id", SqlDbType.Int) idparam.sourcecolumn = "id" ' DataTable に UDT rows を格納 Dim dattable As New DataTable("Points") da.fill(dattable) ' Point 列の内容の表示 Dim r As DataRow For Each r In dattable.rows Dim p As Point = CType(r(1), Point) Console.WriteLine("ID: 0, x=1, y=1", r(0), p.x, p.y) Next r ' 行の更新 (DataTable に行が有る場合 ) If dattable.rows.count > 0 Then Dim oldpoint As Point = CType(datTable.Rows(0)(1), Point) dattable.rows(0)(1) = New Point(oldPoint.X + 1, oldpoint.y + 1) End If ' 最終行の削除 ( 行が有る場合 ) If dattable.rows.count > 0 Then dattable.rows(1).delete( ) End If ' 行の挿入 (100 は主キーの値なので 2 度実行すると失敗する ) dattable.rows.add(100, New Point(100, 200)) ' データベースに変更を書き戻し da.update(dattable) End Sub Private Sub CommandBuilder( ) ' 新しい SqlDataAdapter の生成 Dim da As New SqlDataAdapter( "SELECT id, ts, p FROM dbo.points_ts", connstring) ' データベースから UDT で行を抽出 Dim dattable As New DataTable("Points") da.fill(dattable) ' Point 列の内容の表示 Dim r As DataRow For Each r In dattable.rows Dim p As Point = CType(r(2), Point) Console.WriteLine("ID: 0, x=1, y=1", r(0), p.x, p.y) Next r -29-

30 ' 行の更新 (DataTable に行が有る場合 ) If dattable.rows.count > 0 Then Dim oldpoint As Point = CType(datTable.Rows(0)(2), Point) dattable.rows(0)(2) = New Point(oldPoint.X + 1, oldpoint.y + 1) End If ' 最終行の削除 ( 行が有る場合 ) If dattable.rows.count > 0 Then dattable.rows(1).delete( ) End If ' 行の挿入 (100 は主キーの値なので 2 度実行すると失敗する ) dattable.rows.add(100, Nothing, New Point(100, 200)) ' CommandBuilder を使用して DML ステートメントの作成 Dim bld As New SqlCommandBuilder(da) bld.conflictdetection = ConflictOptions.CompareRowVersion ' データベースに変更を書き戻し da.update(dattable) End Sub Private Function GetConnectionString( ) As String ' 設定ファイルより接続文字列の取得 Return "Data Source=(local);Initial Catalog=AdventureWorks; Integrated Security=SSPI" End Function End Module using System; using System.Data; using System.Data.SqlClient; class Class1 // 接続文字列の取得 private string connstring = GetConnectionString( ); static void Main( ) UserProvidedCommands( ); CommandBuilder( ); static void UserProvidedCommands( ) // 新しい SqlDataAdapter の生成 SqlDataAdapter da = new SqlDataAdapter("SELECT id, p FROM dbo.points", connstring); // INSERT/UPDATE/DELETE コマンドの設定 SqlParameter idparam; SqlParameter pointparam; da.insertcommand = new SqlCommand( "INSERT INTO dbo.points (id, p) VALUES da.selectcommand.connection); -30-