チュートリアル : エンティティクラスの挿入、更新、および削除の動作のカスタマイズ

[アーティクル]
09/17/2008

更新 : November 2007

オブジェクトリレーショナルデザイナ (O/R デザイナ) は、データベース内のオブジェクトに基づく LINQ to SQL クラス (エンティティクラス) を作成および編集するためのビジュアルデザインサーフェイスを提供します。LINQ to SQL を使用すると、LINQ テクノロジを使用して SQL データベースにアクセスできます。詳細については、「統合言語クエリ (LINQ: Language-Integrated Query)」を参照してください。

既定では、更新を実行するロジックは LINQ to SQL ランタイムによって提供されます。ランタイムは、テーブルのスキーマ (列定義と主キー情報) に基づいて、既定の Insert、Update、および Delete の各ステートメントを作成します。既定の動作を使用しない場合は、更新動作を構成し、データベースのデータの操作に必要な Insert、Update、および Delete を実行する特定のストアドプロシージャを指定できます。この方法は、既定の動作が生成されていない場合、たとえばエンティティクラスがビューにマップされている場合にも実行できます。また、データベースのテーブルへのアクセスには常にストアドプロシージャを通すようにすると、既定の更新動作をオーバーライドできます。詳細については、「ストアドプロシージャによる操作のカスタマイズ (LINQ to SQL)」を参照してください。

メモ :
このチュートリアルでは、Northwind データベースで InsertCustomer、UpdateCustomer、および DeleteCustomer の各ストアドプロシージャを使用できるようにしておく必要があります。これらのストアドプロシージャの作成方法の詳細については、「チュートリアル : Northwind の Customers テーブル用更新ストアドプロシージャの作成」を参照してください。

このチュートリアルでは、Northwind データベースで InsertCustomer、UpdateCustomer、および DeleteCustomer の各ストアドプロシージャを使用できるようにしておく必要があります。これらのストアドプロシージャの作成方法の詳細については、「チュートリアル : Northwind の Customers テーブル用更新ストアドプロシージャの作成」を参照してください。

このチュートリアルでは、ストアドプロシージャを使用して、データベースにデータを保存する既定の LINQ to SQL ランタイムの動作をオーバーライドするために必要な手順を示します。

このチュートリアルでは、次のタスクを実行する方法を学習します。

新しい Windows フォームアプリケーションを作成し、LINQ to SQL ファイルを追加します。
Northwind の Customers テーブルにマップされるエンティティクラスを作成します。
LINQ to SQL Customer クラスを参照するオブジェクトデータソースを作成します。
Customer クラスにバインドされる DataGridView を含む Windows フォームを作成します。
フォームの保存機能を実装します。
O/R デザイナにストアドプロシージャを追加することにより、DataContext のメソッドを作成します。
ストアドプロシージャを使用して挿入、更新、および削除を実行するように Customer クラスを構成します。

前提条件

このチュートリアルを完了するには、次の条件が必要です。

Northwind サンプルデータベースの SQL Server バージョンにアクセスします。詳細については、「方法 : サンプルデータベースをインストールする」を参照してください。
Northwind データベースに InsertCustomer、UpdateCustomer、および DeleteCustomer の各ストアドプロシージャが必要です。詳細については、「チュートリアル : Northwind の Customers テーブル用更新ストアドプロシージャの作成」を参照してください。

アプリケーションの作成と LINQ to SQL クラスの追加

LINQ to SQL クラスを操作してデータを Windows フォームに表示できるように、新しい Windows フォームアプリケーションを作成し、LINQ to SQL クラスファイルを追加します。

メモ :
お使いのマシンで、Visual Studio ユーザーインターフェイスの一部の要素の名前や場所が、次の手順とは異なる場合があります。これらの要素は、使用している Visual Studio のエディションや独自の設定によって決まります。詳細については、「Visual Studio の設定」を参照してください。

LINQ to SQL クラスを含む新しい Windows アプリケーションプロジェクトを作成するには

[ファイル] メニューで新しいプロジェクトを作成します。

プロジェクトに「UpdatingwithSProcsWalkthrough」という名前を付けます。

メモ :
O/R デザイナは Visual Basic プロジェクトと C# プロジェクトでサポートされています。したがって、新しいプロジェクトはこれらの言語のどちらかで作成してください。

[Windows フォームアプリケーション] テンプレートをクリックし、[OK] をクリックします。詳細については、「Windows ベースのアプリケーションの作成」を参照してください。

UpdatingwithSProcsWalkthrough プロジェクトが作成されてソリューションエクスプローラに追加されます。
[プロジェクト] メニューの [新しい項目の追加] をクリックします。
[LINQ to SQL クラス] テンプレートをクリックし、[名前] ボックスに「Northwind.dbml」と入力します。
[追加] をクリックします。

プロジェクトに空の LINQ to SQL クラスファイル (Northwind.dbml) が追加され、O/R デザイナが開きます。

Customer エンティティクラスとオブジェクトデータソースの作成

サーバーエクスプローラまたはデータベースエクスプローラから O/R デザイナにテーブルをドラッグして、データベーステーブルにマップされた LINQ to SQL クラスを作成します。結果は、データベース内のテーブルにマップされた LINQ to SQL エンティティクラスになります。作成したエンティティクラスは、パブリックプロパティを持つ他のクラスと同様に、オブジェクトデータソースとして使用できます。

Customer エンティティクラスを作成し、そのエンティティクラスでデータソースを構成するには

サーバーエクスプローラまたはデータベースエクスプローラで、SQL Server バージョンの Northwind サンプルデータベース上の Customer テーブルを探します。詳細については、「方法 : Northwind データベースへのデータ接続を作成する」を参照してください。

サーバーエクスプローラまたはデータベースエクスプローラから O/R デザイナサーフェイスに [Customers] ノードをドラッグします。

Customer という名前のエンティティクラスが作成されます。これには、Customers テーブルの列に対応するプロパティが含まれています。このエンティティクラスは Customers テーブルの 1 人の顧客を表すため、Customers ではなく Customer という名前が付けられます。

メモ :
このような名前の変更動作を複数形化と呼びます。これは [オプション] ダイアログボックス (Visual Studio) でオンまたはオフにできます。詳細については、「方法 : 複数形化をオンおよびオフにする (O/R デザイナ)」を参照してください。

[ビルド] メニューの [UpdatingwithSProcsWalkthrough のビルド] をクリックして、プロジェクトをビルドします。
[データ] メニューの [データソースの表示] をクリックします。
[データソース] ウィンドウで、[新しいデータソースの追加] をクリックします。
[データソースの種類を選択] ページで、[オブジェクト] をクリックし、[次へ] をクリックします。
[UpdatingwithSProcsWalkthrough] ノードを展開し、[Customer] クラスを探して選択します。

メモ :

Customer クラスが使用可能でない場合は、ウィザードをキャンセルし、プロジェクトをビルドしてからウィザードを再実行します。
[完了] をクリックしてデータソースを作成し、Customer エンティティクラスを [データソース] ウィンドウに追加します。

メモ :
Customer クラスが使用可能でない場合は、ウィザードをキャンセルし、プロジェクトをビルドしてからウィザードを再実行します。

Windows フォームに顧客データを表示するための DataGridView の作成

[データソース] ウィンドウから Windows フォームに LINQ to SQL データソース項目をドラッグして、エンティティクラスにバインドされるコントロールを作成します。

エンティティクラスにバインドされるコントロールを追加するには

デザインビューで [Form1] を開きます。
[データソース] ウィンドウから [Form1] に [Customer] ノードをドラッグします。

メモ :

[データソース] ウィンドウを表示するには、[データ] メニューの [データソースの表示] をクリックします。
コードエディタで [Form1] を開きます。
フォームに次のコードを追加します。フォームに対してグローバルになるように、Form1 クラスの内部でありながら、どのメソッドにも属さない位置に追加します。
```
Private NorthwindDataContext1 As New NorthwindDataContext
```
```
private NorthwindDataContext northwindDataContext1
    = new NorthwindDataContext();
```

メモ :
[データソース] ウィンドウを表示するには、[データ] メニューの [データソースの表示] をクリックします。

Form_Load イベントのイベントハンドラを作成し、ハンドラに次のコードを追加します。

CustomerBindingSource.DataSource = NorthwindDataContext1.Customers

customerBindingSource.DataSource
    = northwindDataContext1.Customers;

保存機能の実装

既定では、保存ボタンが有効ではなく、保存機能は実装されていません。また、オブジェクトデータソースに対してデータバインドコントロールを作成しても、変更されたデータをデータベースに保存するコードは自動的には追加されません。ここでは、保存ボタンを有効にし、LINQ to SQL オブジェクトの保存機能を実装する方法について説明します。

保存機能を実装するには

デザインビューで [Form1] を開きます。
CustomerBindingNavigator の保存ボタン (フロッピーディスクのアイコンのボタン) を選択します。
[プロパティ] ウィンドウで、[Enabled] プロパティを [True] に設定します。
保存ボタンをダブルクリックして、イベントハンドラを作成し、コードエディタに切り替えます。
保存ボタンのイベントハンドラに次のコードを追加します。
```
NorthwindDataContext1.SubmitChanges()
```
```
northwindDataContext1.SubmitChanges();
```

更新 (Insert、Update、および Delete) の実行に対する既定の動作のオーバーライド

既定の更新動作をオーバーライドするには

O/R デザイナで LINQ to SQL ファイルを開きます (ソリューションエクスプローラで Northwind.dbml ファイルをダブルクリックします)。
サーバーエクスプローラまたはデータベースエクスプローラで、Northwind データベースの [ストアドプロシージャ] ノードを展開し、InsertCustomers、UpdateCustomers、および DeleteCustomers の各ストアドプロシージャを探します。
3 つのストアドプロシージャをすべて O/R デザイナにドラッグします。

各ストアドプロシージャが DataContext のメソッドとしてメソッドペインに追加されます。詳細については、「DataContext メソッド (O/R デザイナ)」を参照してください。
O/R デザイナで [Customer] エンティティクラスを選択します。
[プロパティ] ウィンドウで [Insert] プロパティを選択します。
[ランタイムを使用] の横にある省略記号 ([...]) をクリックして、[動作の構成] ダイアログボックスを開きます。
[カスタマイズ] を選択します。
[カスタマイズ] ボックスの一覧の [InsertCustomers] メソッドをクリックします。

[適用] をクリックして、選択したクラスと動作の構成を保存します。

メモ :
変更を行うたびに [適用] をクリックすると、各クラスと動作の組み合わせに対して動作の構成を続行できます。[適用] をクリックする前にクラスまたは動作を変更した場合は、警告ダイアログボックスが表示され、ここで変更を適用できます。

[動作] ボックスの一覧の [Update] をクリックします。
[カスタマイズ] を選択します。
[カスタマイズ] ボックスの一覧の [UpdateCustomers] メソッドをクリックします。

[メソッドの引数] および [クラスのプロパティ] の一覧を調べると、テーブルの一部の列には 2 つのメソッドの引数と 2 つのクラスのプロパティがあることがわかります。これにより、変更を追跡したり、同時実行違反をチェックするステートメントを作成したりすることが簡単になります。

Original_CustomerID メソッド引数を CustomerID (オリジナル) クラスプロパティにマップします。

メモ :
既定では、メソッド引数は名前が一致した場合にクラスプロパティにマップされます。プロパティ名が変更され、テーブルとエンティティクラス間で一致しなくなったために、O/R デザイナが正しいマッピングを判断できないときは、マップ先となる同等のクラスプロパティを選択することが必要になる場合があります。また、メソッド引数のマップ先として有効なクラスプロパティがない場合は、[クラスのプロパティ] の値を [(なし)] に設定できます。

既定では、メソッド引数は名前が一致した場合にクラスプロパティにマップされます。プロパティ名が変更され、テーブルとエンティティクラス間で一致しなくなったために、O/R デザイナが正しいマッピングを判断できないときは、マップ先となる同等のクラスプロパティを選択することが必要になる場合があります。また、メソッド引数のマップ先として有効なクラスプロパティがない場合は、[クラスのプロパティ] の値を [(なし)] に設定できます。

[適用] をクリックして、選択したクラスと動作の構成を保存します。
[動作] ボックスの一覧の [Delete] をクリックします。
[カスタマイズ] を選択します。
[カスタマイズ] ボックスの一覧の [DeleteCustomers] メソッドをクリックします。
Original_CustomerID メソッド引数を CustomerID (オリジナル) クラスプロパティにマップします。
[OK] をクリックします。

メモ :
この特定のチュートリアルに限った問題ではありませんが、LINQ to SQL は、ID 列 (自動インクリメント)、rowguidcol 列 (データベースが生成した GUID)、およびタイムスタンプ列であれば、データベースによって生成された値を、挿入時および更新時に自動的に処理します。その他の列型のデータベースによって生成された値は、予想に反して null 値になります。データベースが生成した値を返すには、手動で IsDbGenerated を true に設定し、AutoSync を Always、OnInsert、または OnUpdate のいずれかに設定する必要があります。

この特定のチュートリアルに限った問題ではありませんが、LINQ to SQL は、ID 列 (自動インクリメント)、rowguidcol 列 (データベースが生成した GUID)、およびタイムスタンプ列であれば、データベースによって生成された値を、挿入時および更新時に自動的に処理します。その他の列型のデータベースによって生成された値は、予想に反して null 値になります。データベースが生成した値を返すには、手動で IsDbGenerated を true に設定し、AutoSync を Always、OnInsert、または OnUpdate のいずれかに設定する必要があります。

アプリケーションのテスト

アプリケーションを再実行し、データベース内の顧客レコードが UpdateCustomers ストアドプロシージャによって正しく更新されることを確認します。

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

F5 キーを押します。
グリッド内のレコードを変更して、Update の動作をテストします。
新しいレコードを追加して、Insert の動作をテストします。
保存ボタンをクリックして、変更をデータベースに保存します。
フォームを閉じます。
F5 キーを押し、更新されたレコードと新しく挿入したレコードが永続化されていることを確認します。
手順 3. で作成した新しいレコードを削除して、Delete の動作をテストします。
保存ボタンをクリックして変更を送信し、削除されたレコードをデータベースから削除します。
フォームを閉じます。

F5 キーを押し、削除したレコードがデータベースから削除されていることを確認します。

メモ :
アプリケーションで SQL Server Express Edition を使用している場合、データベースファイルの [出力ディレクトリにコピー] プロパティの値によっては、手順 10. で F5 キーを押したときに変更が表示されない場合があります。詳細については、「方法 : プロジェクトでローカルデータファイルを管理する」を参照してください。

アプリケーションで SQL Server Express Edition を使用している場合、データベースファイルの [出力ディレクトリにコピー] プロパティの値によっては、手順 10. で F5 キーを押したときに変更が表示されない場合があります。詳細については、「方法 : プロジェクトでローカルデータファイルを管理する」を参照してください。

次の手順

アプリケーションの要件に応じて、LINQ to SQL エンティティクラスの作成後にいくつかの手順を実行することが必要な場合があります。このアプリケーションで行うことができる拡張には次のものがあります。

更新時の同時実行チェックを実装します。詳細については、「オプティミスティック同時実行の概要 (LINQ to SQL)」を参照してください。
LINQ クエリを追加してデータをフィルタ処理します。詳細については、「LINQ クエリの概要」を参照してください。

参照

次の方法で共有

チュートリアル : エンティティクラスの挿入、更新、および削除の動作のカスタマイズ

前提条件

アプリケーションの作成と LINQ to SQL クラスの追加

LINQ to SQL クラスを含む新しい Windows アプリケーションプロジェクトを作成するには

Customer エンティティクラスとオブジェクトデータソースの作成

Customer エンティティクラスを作成し、そのエンティティクラスでデータソースを構成するには

Windows フォームに顧客データを表示するための DataGridView の作成

エンティティクラスにバインドされるコントロールを追加するには

保存機能の実装

保存機能を実装するには

更新 (Insert、Update、および Delete) の実行に対する既定の動作のオーバーライド

既定の更新動作をオーバーライドするには

アプリケーションのテスト

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

次の手順

参照

処理手順

概念

その他の技術情報

その他のリソース

次の方法で共有

チュートリアル : エンティティ クラスの挿入、更新、および削除の動作のカスタマイズ

前提条件

アプリケーションの作成と LINQ to SQL クラスの追加

LINQ to SQL クラスを含む新しい Windows アプリケーション プロジェクトを作成するには

Customer エンティティ クラスとオブジェクト データ ソースの作成

Customer エンティティ クラスを作成し、そのエンティティ クラスでデータ ソースを構成するには

Windows フォームに顧客データを表示するための DataGridView の作成

エンティティ クラスにバインドされるコントロールを追加するには

保存機能の実装

保存機能を実装するには

更新 (Insert、Update、および Delete) の実行に対する既定の動作のオーバーライド

既定の更新動作をオーバーライドするには

アプリケーションのテスト

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

次の手順

参照

処理手順

概念

その他の技術情報

その他のリソース

チュートリアル : エンティティクラスの挿入、更新、および削除の動作のカスタマイズ

LINQ to SQL クラスを含む新しい Windows アプリケーションプロジェクトを作成するには

Customer エンティティクラスとオブジェクトデータソースの作成

Customer エンティティクラスを作成し、そのエンティティクラスでデータソースを構成するには

エンティティクラスにバインドされるコントロールを追加するには