Visual Studio でのデータセットの操作

[アーティクル]
08/09/2011

データセットは、アプリケーションで使用するためにデータを一時的に格納できるデータテーブルを含むオブジェクトです。アプリケーションでデータを操作する必要がある場合、データをデータセットに読み込むことができ、それがアプリケーションで操作するデータのローカルのメモリ内キャッシュになります。データセット内のデータは、アプリケーションがデータベースから切断されても操作できます。データセットでは、データへの変更に関する情報が保持されるので、更新情報を追跡して、アプリケーションがデータベースに再度接続されたときにデータベースに更新情報を送信できます。

次のトピックでは、Visual Studio でデータセットを操作する方法について詳しく説明します。

トピック	説明
データセットデザイナー	データセットを作成するためのデザイン時ツールについて説明します。
方法 : 型指定されたデータセットを作成する	Visual Studio のデザインツールで、型指定されたデータセットを作成する方法を説明します。
方法 : データセットの機能を拡張する	デザイナーで生成されるコード以外のコードを追加するための、データセットの部分クラスを作成する手順を示します。
方法 : データセットデザイナーでデータセットを開く	ソリューションエクスプローラーと [データソース] ウィンドウからデータセットを開く方法について説明します。
方法 : データセットを編集する	データセットデザイナーを使用して、データセット内のオブジェクトを編集する方法を説明します。
チュートリアル : データセットデザイナーでのデータセットの作成	データソース構成ウィザードを使用せずに、型指定されたデータセットを作成する方法を、段階ごとに説明します。
DataTable のデザイン	デザイン時ツールを使用してデータテーブルの作成と編集を行う方法について説明しているトピックへのリンクを示します。
データセットのリレーションシップ	デザイン時ツールを使用してデータリレーションシップの作成と編集を行う方法について説明しているトピックへのリンクを示します。
TableAdapter	デザイン時ツールを使用して TableAdapter の作成と編集を行う方法について説明しているトピックへのリンクを示します。
n 層アプリケーションでのデータセットの操作	n 層アプリケーションと、n 層アプリケーションでデータセットを操作するために使用できる機能について説明します。

DataSet の構造はリレーショナルデータベースに似ています。データセットは、テーブル、行、列、制約、およびリレーションシップの階層オブジェクトモデルを公開します。

データセットには、型指定されたデータセットと型指定されていないデータセットがあります。詳細については、後の「型指定されたデータセットと型指定されていないデータセット」を参照してください。型指定されたデータセットは、.xsd ファイルからスキーマ (テーブルと列の構造体) を派生させるので、プログラミングが簡単です。アプリケーションでは、型指定されたデータセットと型指定されていないデータセットのどちらでも使用できます。ただし、型指定されたデータセットを使用した方が、Visual Studio でより多くのツールがサポートされているため、データセットに関するプログラミングが簡単になり、エラーも起こりにくくなります。

型指定されたデータセットは、データソース構成ウィザードを実行するか、[プロジェクト] メニューの [新しい項目の追加] で [データセット] 項目を追加して、作成します。詳細については、「方法 : 型指定されたデータセットを作成する」を参照してください。

型指定されていないデータセットは、ツールボックスから [データセット] 項目を Windows フォームデザイナーまたはコンポーネントデザイナーにドラッグして、作成します。

データセットを作成したら、データセットデザイナーで編集します。

.NET Framework 名前空間の次の部分を使用して、型指定されたデータセットと型指定されていないデータセットを作成して操作します。

データセットは、System.Data 名前空間内にあります。

システムデータデータセット名前空間

データセットのオブジェクトは、プロパティやコレクションなどの標準的なプログラミング構造によって公開されます。次に例を示します。

DataSet クラスには、データテーブルの DataTableCollection コレクションと DataRelation オブジェクトの DataRelationCollection コレクションが格納されます。
DataTable クラスには、テーブルの行の DataRowCollection コレクション、データ列の DataColumnCollection コレクション、およびデータリレーションシップの ChildRelations コレクションと ParentRelations コレクションが格納されます。
DataRow クラスには RowState プロパティが含まれています。このプロパティの値は、データテーブルがデータベースから最初に読み込まれた後で行が変更されているかどうか、およびどのように変更されているかを示します。 RowState プロパティの値には、Deleted、Modified、Added、Unchanged などがあります。

データセットへのデータの読み込み

既定では、データセットには実際のデータは含まれていません。データセットにデータを読み込む操作は、実際にはデータセットを構成する個々の DataTable オブジェクトにデータを読み込む操作を意味します。 TableAdapter クエリを実行するか、またはデータアダプター (たとえば、SqlDataAdapter) のコマンドを実行して、データテーブルにデータを読み込みます。データセットにデータを読み込む場合は、各種のイベントが発生したり、制約が検査されたりします。データセットへのデータの読み込みの詳細については、「アプリケーションへのデータのフェッチ」を参照してください。

データセットにデータを読み込むコードは、[データソース] ウィンドウから Windows アプリケーションのフォームに項目をドラッグしたときに、フォームのロードイベントハンドラーに自動的に追加されます。詳細については、「チュートリアル: Windows フォームでのデータの表示」の手順を参照してください。

TableAdapter を使用してデータセットにデータを読み込む例を次に示します。

Me.CustomersTableAdapter.Fill(Me.NorthwindDataSet.Customers)

this.customersTableAdapter.Fill(this.northwindDataSet.Customers);

データセットにデータを読み込むにはさまざまな方法があります。

データウィザードなどのデザイン時ツールを使用してデータセットを作成した場合、TableAdapter の Fill メソッドを呼び出してください (TableAdapter は、既定の Fill メソッドで作成されます。ただし、名前を変更できるため、実際には別の名前になっている場合もあります)。詳細については、「方法 : データセットにデータを読み込む」の「TableAdapter を使用したデータセットへのデータの読み込み」のセクションを参照してください。
DataAdapter の Fill メソッドを呼び出します。詳細については、「DataAdapter からの DataSet の読み込み (ADO.NET)」を参照してください。
DataRow オブジェクトを作成してテーブルの DataRowCollection コレクションにそれらを追加することにより、データセットのテーブルに手動でデータを読み込みます。これは実行時にだけ行うことができます。デザイン時には DataRowCollection コレクションを設定できません。詳細については、「DataTable へのデータの追加」を参照してください。
XML のドキュメントまたはストリームをデータセットに読み込みます。詳細については、ReadXml メソッドのトピックを参照してください。例については、「チュートリアル : データセットへの XML データの読み込み」を参照してください。
他のデータセットの内容をマージ (コピー) します。この方法は、アプリケーションがいくつかの異なるソース (複数の XML Web サービスなど) からデータセットを取得し、それを 1 つのデータセットに統合する必要がある場合に便利です。詳細については、「DataSet の内容のマージ (ADO.NET)」を参照してください。
他の DataTable の内容をマージ (コピー) します。

データセット内のデータのデータベースへの保存

データセット内のレコードが変更された場合は、変更をデータベースにも反映する必要があります。データセットの変更をデータベースに書き込むには、データセットとその対応するデータベースの間でやり取りを行う TableAdapter または DataAdapter の Update メソッドを呼び出します。

Visual Studio のデータデザインツールを使用する場合、TableAdapter の Update メソッドを呼び出し、保存するデータテーブルを渡して、データをデータベースに送信します。次に例を示します。

CustomersTableAdapter.Update(NorthwindDataSet.Customers)

customersTableAdapter.Update(northwindDataSet.Customers);

更新処理をより綿密に制御するには、TableAdapter の DBDirect メソッドのいずれかを呼び出すことで、各データ行の個別の値を渡すことができます。詳細については、「方法 : TableAdapter を使用してデータを更新する」および「チュートリアル : TableAdapter DBDirect メソッドを使用してデータを保存する」を参照してください。

個別のレコードを操作するために使用される DataRow クラスには、RowState プロパティが含まれています。このプロパティの値は、データテーブルがデータベースから最初に読み込まれた後で行が変更されているかどうか、およびどのように変更されているかを示します。使用できる値は、Deleted、Modified、Added、および Unchanged です。 TableAdapter と DataAdapter の Update メソッドは、RowState プロパティの値を調べて、どのレコードをデータベースに書き込み、どのデータベースコマンド (InsertCommand、UpdateCommand、DeleteCommand) を起動するかを決定します。

データ更新の詳細については、「データの保存」を参照してください。

データセット内でのレコード間の移動

データセットは完全に非接続のデータコンテナーであるため、ADO レコードセットとは異なり、現在のレコードという概念をサポートしていません。その代わり、データセット内のすべてのレコードをいつでも使用できます。

現在のレコードが存在しないため、現在のレコードを指す特定のプロパティはありません。また、レコード間で移動するためのメソッドやプロパティもありません (後のメモを参照)。データセット内の個別のテーブルにはオブジェクトとしてアクセスできます。各テーブルは、行のコレクションを公開します。このコレクションは他のすべてのコレクションと同じように扱うことができ、コレクションのインデックスによって行にアクセスしたり、プログラミング言語でコレクション固有のステートメントを使用したりできます。

たとえば、Customers テーブルの 4 行目を取得するには、次のようなコードを使用します。

TextBox1.Text = NorthwindDataSet.Customers(3).ContactName

textBox1.Text = northwindDataSet.Customers[3].ContactName;

注意

フォーム内のコントロールをデータセットにバインドする場合、BindingNavigator コンポーネントを使用して、各レコードへのアクセスを簡便化できます。詳細については、「方法 : Windows フォームでデータ間を移動する」を参照してください。

LINQ to DataSet

LINQ to DataSet を使用すれば、DataSet オブジェクトのデータを対象に統合言語クエリ (LINQ: Language-Integrated Query) を実行することが可能になります。詳細については、「LINQ to DataSet」を参照してください。

データセットと XML

データセットは、XML で表すことができるデータのリレーショナルビューです。データセットと XML の間のそのような関係により、データセットでは次のような機能を利用できます。

データセットの構造、つまりテーブル、列、リレーションシップ、および制約を XML スキーマ内で定義できます。構造化された情報を格納しているスキーマに対して、データセットは ReadXmlSchema メソッドと WriteXmlSchema メソッドを使用して読み取りおよび書き込みを行うことができます。スキーマが存在しない場合、データセットは、リレーショナルに組み立てられる XML ドキュメント内のデータから InferXmlSchema メソッドを使用してスキーマを推論できます。 XML のスキーマの詳細については、「XML スキーマの作成」を参照してください。
データセットクラスを作成して、データ構造体を定義するスキーマ情報を取り込むことができます。これを型指定されたデータセットと呼びます。型指定されたデータセットを作成する方法については、「方法 : 型指定されたデータセットを作成する」を参照してください。
データセットの ReadXml メソッドを使用して、XML のドキュメントやストリームをデータセットに読み込むことができます。また、データセットの WriteXml メソッドを使用して、データセットを XML として書き出すこともできます。 XML はアプリケーション間でデータを交換するための標準形式であるため、これにより、ほかのアプリケーションから送信された XML 形式の情報をデータセットに読み込むことができます。同様に、データセットのデータを XML のストリームまたはドキュメントとして書き出すことにより、ほかのアプリケーションとデータを共有したり、単に標準形式で保存したりできます。
データセットまたはデータテーブルの内容の XML ビュー (XmlDataDocument オブジェクト) を作成し、リレーショナルメソッド (データセットによる) または XML メソッドのいずれかを使用して、データを表示および操作できます。 2 つのビューは、変更されるたびに自動的に同期をとります。

型指定されたデータセットと型指定されていないデータセット

型指定されたデータセットは、まず基本 DataSet クラスから派生し、次にデータセットデザイナーの情報を使用して生成されるデータセットです。この情報は .xsd ファイルに格納されており、厳密に型指定された新しいデータセットクラスの生成に使用されます。スキーマの情報 (テーブルや列など) は、新しいデータセットクラスの最上位のオブジェクトとプロパティとして生成され、組み込まれます。型指定されたデータセットは、基本の DataSet クラスから継承するため、型指定されたクラスでは、DataSet クラスのすべての機能を使用できます。また、DataSet クラスのインスタンスをパラメーターとして取るメソッドで使用できます。

対照的に、型指定されていないデータセットには対応する組み込みスキーマがありません。型指定されたデータセットと同様に、型指定されていないデータセットにもテーブルや列などが含まれますが、それはコレクションとしてだけ公開されます。ただし、型指定されていないデータセット内にテーブルなどのデータ要素を手動で作成した後で、データセットの WriteXmlSchema メソッドを使用してデータセットの構造をスキーマとしてエクスポートできます。

型指定されたデータセットと型指定されていないデータセットにおけるデータアクセスの比較

型指定されたデータセットのクラスには、オブジェクトモデルが格納されます。このオブジェクトモデルには、テーブルと列の実際の名前を値として格納するプロパティが格納されます。たとえば、型指定されたデータセットで作業している場合は、次に示すコードを使用して列を参照できます。

' This accesses the CustomerID column in the first row of the Customers table.
Dim customerIDValue As String = NorthwindDataSet.Customers(0).CustomerID

// This accesses the CustomerID column in the first row of the Customers table.
string customerIDValue = northwindDataSet.Customers[0].CustomerID;

一方、型指定されていないデータセットで作業している場合は、次に示すコードを使用します。

Dim customerIDValue As String =
    CType(dataset1.Tables("Customers").Rows(0).Item("CustomerID"), String)

string customerIDValue = (string)
    dataset1.Tables["Customers"].Rows[0]["CustomerID"];

型付きアクセスの方が読みやすいだけでなく、Visual Studio コードエディターの IntelliSense によって完全にサポートされています。扱いやすさに加えて、型指定されたデータセットの構文ではコンパイル時に型チェックが行われるため、データセットメンバーに値を割り当てる場合にエラーの発生する可能性が低くなります。 DataSet 内の列の名前を変更して、アプリケーションをコンパイルすると、ビルドエラーが発生します。 [タスク一覧] 内のビルドエラーをダブルクリックすると、変更前の列名を参照するコード行に直接移動できます。実行時のテーブルや列へのアクセスも、型指定されたデータセットの方が少し速くなります。これは、アクセスが実行時にコレクションを通して決定される代わりに、コンパイル時に決定されるためです。

型指定されたデータセットには多くの利点がありますが、型指定されていないデータセットを使用すると便利な状況も各種あります。最も明らかな状況は、データセットに対して使用できるスキーマがない場合です。この状況は、たとえば、アプリケーションがデータセットを返すコンポーネントとやり取りするときに、その構造が事前にわかっていない場合に生じます。同様に、操作対象のデータが予測可能な静的構造を持っていない場合もあります。そのような場合、型指定されたデータセットを使用するのは実用的ではありません。なぜなら、データ構造が変更されるたびに型指定されたデータセットクラスを再生成する必要があるためです。

より一般的には、使用可能なスキーマなしでデータセットを動的に作成する場合が多くあります。そのような場合、リレーショナル方法でデータを表すことができる限り、データセットは単に情報を保持することができる便利な構造です。同時に、ほかのプロセスに渡すために情報をシリアル化したり XML ファイルに書き出したりするデータセットの機能も利用できます。

データセットにおける大文字と小文字の区別

データセット内のテーブル名や列名は、既定で大文字と小文字が区別されません。つまり、データセット内の "Customers" というテーブルは、"customers" という形でも参照できます。これは、SQL Server の既定の動作などの多くのデータベースにおける名前付け規則に対応しています。これらのデータベースでは、データ要素の名前を大文字と小文字の違いだけでは区別できません。

注意

データセットとは異なり、XML ドキュメントでは大文字と小文字が区別されるため、スキーマで定義するデータ要素の名前では大文字と小文字が区別されます。たとえば、スキーマプロトコルでは、同じスキーマで "Customers" という名前のテーブルと "customers" という名前の別のテーブルを定義できます。そのため、大文字と小文字の違いしかない要素を含むスキーマを使用してデータセットクラスを生成すると、名前が競合することがあります。

ただし、データセット内でデータを解釈するときに、大文字と小文字の区別が考慮される場合もあります。たとえば、データセットテーブル内のデータにフィルターをかける場合には、検索条件との比較で大文字と小文字を区別するかどうかによって異なる結果が返されることがあります。フィルター処理、検索、および並べ替えにおける大文字と小文字の区別は、データセットの CaseSensitive プロパティを設定することによって制御できます。データセット内のすべてのテーブルは、このプロパティの値を既定で継承します。各テーブルについてこのプロパティをオーバーライドするには、そのテーブルの CaseSensitive プロパティを設定します。

制約

ほとんどのデータベースと同様に、データセットはデータの整合性を保証する手段として制約をサポートしています。制約は、テーブルの行を挿入、更新、または削除するときに適用される規則です。 2 つの種類の制約を定義できます。

列の新しい値がテーブル内で重複しないことをチェックする UNIQUE 制約。
マスターテーブル内のレコードが更新または削除されるときに関連する子レコードをどのように更新するかの規則を定義する外部キーの制約。たとえば、子レコードが作成される前に、外部キーの制約により親レコードの存在を確認します。

データセットでは、制約に個別のテーブル (外部キーの制約の場合) または列 (列の値が重複しないことを保証する UNIQUE 制約の場合) が関連付けられます。制約は、UniqueConstraint 型または ForeignKeyConstraint 型のオブジェクトとして実装されます。これらの制約は、DataTable の Constraints コレクションに追加されます。また、DataColumn の Unique プロパティを true に設定するだけでも、UNIQUE 制約を指定できます。

データセット自体は、制約が適用されるかどうかを指定するブール型の EnforceConstraints プロパティをサポートしています。既定では、このプロパティは true に設定されます。ただし、制約を一時的にオフにすると便利な場合もあります。最も一般的な例は、レコードの変更によって一時的に無効な状態が発生するような場合です。そのような場合は、変更を完了して (それによって有効な状態に戻って) から、制約を再び有効にできます。

Visual Studio では、データセットを定義するときに制約が暗黙に作成されます。データセットに主キーを追加すると、その主キー列に対して UNIQUE 制約が暗黙に作成されます。それ以外の列に UNIQUE 制約を指定するには、その列の Unique プロパティを true に設定します。

外部キーの制約を作成するには、データセット内に DataRelation オブジェクトを作成します。 DataRelation オブジェクトを使用すると、関連するレコードに関する情報をプログラムで取得できるだけでなく、外部キーの制約の規則を定義できます。

データセットの拡張プロパティ

拡張プロパティは、.xsd ファイルからデータセットを生成する際に名前の競合が発生した場合に、名前のマッピングを提供します。 .xsd ファイル内の識別子が、データセットの生成元によって作成された名前と異なる場合、msprop 名前空間でそのデータセットに拡張プロパティが追加されます。生成される可能性のある拡張プロパティを以下の表に示します。

オブジェクト	拡張プロパティ
DataSet	msprop:Generator_UserDSName
	msprop:Generator_DataSetName
DataTable	msprop:Generator_UserTableName
	msprop:Generator_TablePropName
	msprop:Generator_TableVarName
	msprop:Generator_TableClassName
	msprop:Generator_RowClassName
	msprop:Generator_RowEvHandlerName
	msprop:Generator_RowEvArgName
DataColumn	msprop:Generator_UserColumnName
	msprop:Generator_ColumnPropNameInTable
	msprop:Generator_ColumnVarNameInTable
	msprop:Generator_ColumnPropNameInRow