テーブル値関数 (TVF)

[アーティクル]
09/12/2023

Note

EF5 以降のみ - このページで説明する機能、API などは、Entity Framework 5 で導入されました。以前のバージョンを使用している場合、一部またはすべての情報は適用されません。

ビデオとステップバイステップのチュートリアルでは、Entity Framework Designer を使用してテーブル値関数 (TVF) をマップする方法について説明します。また、LINQ クエリから TVF を呼び出す方法についても説明します。

現在、TVF は Database First ワークフローでのみサポートされています。

TVF のサポートは Entity Framework バージョン 5 で導入されました。テーブル値関数、列挙型、空間型などの新機能を使用するには、.NET Framework 4.5 をターゲットにする必要があることに注意してください。既定では、Visual Studio 2012 は .NET 4.5 をターゲットにしています。

TVF はストアドプロシージャとよく似ていますが、TVF の結果はコンポーザブルであるという重要な違いが 1 つあります。つまり、TVF の結果は LINQ クエリで使用できますが、ストアドプロシージャの結果は使用できません。

ビデオを見る

発表者: Julia Kornich

WMV | MP4 | WMV (ZIP)

前提条件

このチュートリアルを完了するには、次を行う必要があります。

School データベースをインストールする。
最新バージョンの Visual Studio を用意する

プロジェクトをセットアップする

Visual Studio を開きます
[ファイル] メニューの [新規作成] をポイントし、[プロジェクト] をクリックします
左ペインで [Visual C#] をクリックし、[コンソール] テンプレートを選択します
プロジェクトの名前として「TVF」と入力し、[OK] をクリックします

TVF をデータベースに追加する

[表示] -> [SQL Server オブジェクトエクスプローラー] を選択します
LocalDB がサーバーの一覧に表示されていない場合は、[SQL Server] を右クリックし、[SQL Server の追加] を選択します既定の Windows 認証を使用して、LocalDB サーバーに接続します
[LocalDB] ノードを展開します
[データベース] ノードで、[School] データベースノードを右クリックし、[新しいクエリ] を選択します
T-SQL エディターに、次の TVF 定義を貼り付けます

CREATE FUNCTION [dbo].[GetStudentGradesForCourse]

(@CourseID INT)

RETURNS TABLE

RETURN
    SELECT [EnrollmentID],
           [CourseID],
           [StudentID],
           [Grade]
    FROM   [dbo].[StudentGrade]
    WHERE  CourseID = @CourseID

T-SQL エディターでマウスの右ボタンをクリックし、[実行] を選択します
GetStudentGradesForCourse 関数が School データベースに追加されます

Create a Model (モデルの作成)

ソリューションエクスプローラーで、プロジェクト名を右クリックして [追加] をポイントし、[新しい項目] をクリックします
左側のメニューから [データ] を選択し、[テンプレート] ペインの [ADO.NET Entity Data Model] を選択します
ファイル名として「TVFModel.edmx」と入力し、[追加] をクリックします
[モデルのコンテンツの選択] ダイアログボックスで、[データベースから生成] を選択し、[次へ] をクリックします
[新しい接続] をクリックします [サーバー名] テキストボックスに「(localdb)\mssqllocaldb」と入力しますデータベース名として「School」と入力します [OK] をクリックします
[データベースオブジェクトの選択] ダイアログボックスの [テーブル] ノードで、[Person]、[StudentGrade]、[Course] の各テーブルを選択します
[ストアドプロシージャと関数] ノードの下にある [GetStudentGradesForCourse] 関数を選択します注: Visual Studio 2012 以降、Entity Designer では、ストアドプロシージャと関数を一括でインポートできるようになりました
[完了] をクリックします。
モデルを編集するためのデザインサーフェイスを提供する Entity Designer が表示されます。 [データベースオブジェクトの選択] ダイアログボックスで選択したすべてのオブジェクトがモデルに追加されます。
既定では、インポートされた各ストアドプロシージャまたは関数の結果の形状は、エンティティモデル内では自動的に新しい複合型になります。しかし、GetStudentGradesForCourse 関数の結果は StudentGrade エンティティにマップする必要があります。デザイン画面を右クリックし、[モデルブラウザー] を選択しますモデルブラウザーで、[関数インポート] を選択し、[GetStudentGradesForCourse] 関数をダブルクリックします [関数インポートの編集] ダイアログボックスで、[エンティティ] を選択し、[StudentGrade] を選択します

データの永続化と取得

Main メソッドが定義されているファイルを開きます。 Main 関数に次のコードを追加します。

次のコードは、テーブル値関数を使用するクエリを作成する方法を示しています。このクエリによって、関連するコースタイトルと、評価が 3.5 以上の関連する学生を含む匿名型に結果が射影されます。

using (var context = new SchoolEntities())
{
    var CourseID = 4022;
    var Grade = 3.5M;

    // Return all the best students in the Microeconomics class.
    var students = from s in context.GetStudentGradesForCourse(CourseID)
                            where s.Grade >= Grade
                            select new
                            {
                                s.Person,
                                s.Course.Title
                            };

    foreach (var result in students)
    {
        Console.WriteLine(
            "Couse: {0}, Student: {1} {2}",
            result.Title,  
            result.Person.FirstName,  
            result.Person.LastName);
    }
}

アプリケーションをコンパイルして実行します。このプログラムの出力は、次のようになります。

Couse: Microeconomics, Student: Arturo Anand
Couse: Microeconomics, Student: Carson Bryant

まとめ

このチュートリアルでは、Entity Framework Designer を使用してテーブル値関数 (TVF) をマップする方法について説明しました。また、LINQ クエリから TVF を呼び出す方法についても説明しました。