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

[アーティクル]
10/05/2023

Note

データセットと関連クラスは、アプリケーションがデータベースから切断されている間にアプリケーションがメモリ内のデータを操作できるようにする、2000 年代初期からのレガシ .NET Framework テクノロジです。これらが特に役立つのは、ユーザーがデータを変更し、変更をデータベースに戻して保持できるようにするアプリケーションです。データセットは非常に優れたテクノロジであることが証明されていますが、新しい .NET アプリケーションでは Entity Framework Core を使用することをお勧めしています。 Entity Framework には、オブジェクトモデルとして表形式データを操作する、より自然な方法が用意されており、よりシンプルなプログラミングインターフェイスが備わっています。

Visual Studio の LINQ to SQL ツールには、データベース内のオブジェクトに基づいて LINQ to SQL クラス (エンティティクラス) を作成および編集するためのビジュアルデザインサーフェイスが用意されています。 LINQ to SQL を使用すると、LINQ テクノロジを使用して SQL データベースにアクセスできます。詳細については、「LINQ (統合言語クエリ)」を参照してください。

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

注意

このチュートリアルでは、Northwind データベースで InsertCustomer、UpdateCustomer、および DeleteCustomer の各ストアドプロシージャを使用できるようにしておく必要があります。

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

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

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

必須コンポーネント

このチュートリアルでは SQL Server Express LocalDB と Northwind サンプルデータベースを使用します。

SQL Server Express LocalDB がない場合は、SQL Server Express のダウンロードページからインストールするか、Visual Studio インストーラーを使用してインストールします。 Visual Studio インストーラーでは、データストレージとデータ処理ワークロードの一部として、または個別のコンポーネントとして、SQL Server Express LocalDB をインストールできます。
次の手順に従って、Northwind サンプルデータベースをインストールします。
1. Visual Studio で、 [SQL Server オブジェクトエクスプローラー] ウィンドウを開きます。 (SQL Server オブジェクトエクスプローラーは、Visual Studio インストーラーのデータストレージとデータ処理ワークロードの一部としてインストールされます)。 [SQL Server] ノードを展開します。 LocalDB インスタンスを右クリックし、 [新しいクエリ] を選択します。
  
  クエリエディターウィンドウが開きます。
2. Northwind Transact-SQL スクリプトをクリップボードにコピーします。この T-SQL スクリプトを使用すると、Northwind データベースが新規作成され、データが設定されます。
3. T-SQL スクリプトをクエリエディターに貼り付け、 [実行] ボタンを選択します。
  
  しばらくすると、クエリの実行が完了し、Northwind データベースが作成されます。

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

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

Note

この記事で紹介する Visual Studio ユーザーインターフェイス要素の一部は、お使いのコンピューターでは名前や場所が異なる場合があります。 Visual Studio のエディションや環境設定がお使いのものと異なる場合があります。詳細については、「Visual Studio IDE のカスタマイズ」を参照してください。

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

Visual Studio の [ファイル] メニューで､ [新規作成]>[プロジェクト] を選択します。
左側のペインで [Visual C#] または [Visual Basic] を展開し、 [Windows デスクトップ] を選択します。
中央のペインで、 [Windows フォームアプリ] プロジェクトタイプを選択します。
プロジェクトに UpdatingWithSProcsWalkthrough という名前を付け、 [OK] を選択します。

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 テーブルを探します。
サーバーエクスプローラーまたはデータベースエクスプローラーから *O/R デザイナー サーフェイスに [Customers] ノードをドラッグします。

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

Note

このような名前の変更動作を複数形化と呼びます。これは [オプション] ダイアログボックスでオンまたはオフにできます。詳細については、「方法: 複数形化をオンおよびオフにする (O-R デザイナー)」を参照してください。
[ビルド] メニューの [UpdatingwithSProcsWalkthrough のビルド] をクリックして、プロジェクトをビルドします。
[データソース] ウィンドウを開くには、 [データ] メニューの [データソースの表示] をクリックします。
[データソース] ウィンドウで、 [新しいデータソースの追加]をクリックします。
[データソースの種類を選択] ページで、[オブジェクト] をクリックし、[次へ] をクリックします。
[UpdatingwithSProcsWalkthrough] ノードを展開し、[Customer] クラスを探して選択します。

Note

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

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

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

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

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

Note

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

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

customerBindingSource.DataSource
    = northwindDataContext1.Customers;

CustomerBindingSource.DataSource = NorthwindDataContext1.Customers

保存機能を実装する

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

保存機能を実装するには

デザインビューで [Form1] を開きます。
CustomerBindingNavigator の保存ボタン (フロッピーディスクのアイコンのボタン) を選択します。
[プロパティ] ウィンドウで、[Enabled] プロパティを [True] に設定します。
保存ボタンをダブルクリックして、イベントハンドラーを作成し、コードエディターに切り替えます。
保存ボタンのイベントハンドラーに次のコードを追加します。
- C#
- VB
```
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] メソッドを選択します。
[適用] をクリックして、選択したクラスと動作の構成を保存します。

Note

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

[メソッドの引数] および [クラスのプロパティ] のリストを調べると、テーブルの一部の列には 2 つのメソッドの引数と 2 つのクラスのプロパティがあることがわかります。これにより、変更を追跡したり、コンカレンシー違反をチェックするステートメントを作成したりすることが簡単になります。
Original_CustomerID メソッド引数を CustomerID (オリジナル) クラスプロパティにマップします。

Note

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

Note

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

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

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

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

Note

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

次のステップ

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

更新時のコンカレンシーチェックを実装します。詳しくは、「オプティミスティックコンカレンシー: 概要」を参照してください。
LINQ クエリを追加してデータをフィルター処理します。詳しくは、「LINQ クエリの概要 (C#)」を参照してください。

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

必須コンポーネント

アプリケーションの作成と 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 エンティティクラスを作成し、そのエンティティクラスでデータソースを構成するには

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