クエリ結果の構造化 (Entity Framework)

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

クエリを実行すると、クエリで要求されたオブジェクトのみが返されます。たとえば、Adventure Works Sales Model に対するクエリによって Customer オブジェクトが返される場合、Customer と SalesOrderHeader の間にリレーションシップが存在しても、既定では SalesOrderHeader オブジェクトは返されません。この動作により、アプリケーションはオブジェクトクエリから返されるデータの範囲を常に把握するようになります。既定では、エンティティ型の間のアソシエーションを表すリレーションシップオブジェクトが常に返されます。オブジェクトが EDM の概念スキーマに基づいて生成されると、ナビゲーションプロパティはアソシエーションの両端のエンティティオブジェクトに対して生成されます。これらのナビゲーションプロパティは、一対一または多対一のリレーションシップの "一" の側では EntityReference、一対多または多対多のリレーションシップの "多" の側では EntityCollection を返します。詳細については、「Entity Data Model のリレーションシップ」を参照してください。

ナビゲーションプロパティを使用すると、これらのリレーションシップを明示的にナビゲートする Entity SQL または LINQ to Entities クエリを作成できます。詳細については、「ナビゲーションプロパティを使用してリレーションシップをナビゲートする方法 (Entity Framework)」を参照してください。ただし、クエリ結果を構築するために、クエリ内でリレーションシップを明示的にナビゲートする必要はありません。参照オブジェクトも読み込むようにクエリ結果を拡張できる別の方法が 2 つあります。1 つはクエリパスを指定する方法で、もう 1 つはナビゲーションプロパティを使用して関連オブジェクトを明示的に読み込む方法です。結果をさらに制御するには、クエリパスを定義してから、選択した関連オブジェクトのみを明示的に読み込みます。

使用するオプションを選択する際には、データベースに対する要求数と 1 つのクエリで返されるデータ量の間でのトレードオフに注意してください。クエリパスは、クエリによって返されるオブジェクトのグラフを定義します。クエリパスを定義する場合、1 つの結果セット内のパスによって定義されたすべてのオブジェクトを返すには、データベースに対する 1 つの要求のみが必要になります。オブジェクトを明示的に読み込む場合は、データベースへの複数のラウンドトリップが必要になり、複数の有効な結果セットも必要になることがありますが、返されるデータ量は読み込み中のオブジェクトのみに制限されています。

クエリ結果を構造化するためのクエリパスの定義

クエリパスを指定するには、オブジェクトグラフの文字列表記を ObjectQuery の Include メソッドに渡します。このパスは、オブジェクトクエリの実行時に返す関連オブジェクトを指定します。たとえば、Contact オブジェクトに対するクエリで定義されたクエリパスにより、関連する各 SalesOrderHeader および SalesOrderDetail が必ず返されます。以下の LINQ to Entities、Entity SQL、およびクエリビルダメソッドを使用するクエリの例を参照してください。

LINQ to Entities

' Define a LINQ query with a path that returns 
' orders and items for a contact.
Dim contacts = (From contact In context.Contact _
    .Include("SalesOrderHeader.SalesOrderDetail") _
    Select contact).FirstOrDefault()

// Define a LINQ query with a path that returns 
// orders and items for a contact.
var contacts = (from contact in context.Contact
              .Include("SalesOrderHeader.SalesOrderDetail")
              select contact).FirstOrDefault();

Entity SQL

' Define an object query with a path that returns 
' orders and items for a specific contact.              
Dim queryString As String = _
    "SELECT VALUE TOP(1) Contact FROM " + _
    "AdventureWorksEntities.Contact AS Contact"

' Define the object query with the query string.
Dim contactQuery As New ObjectQuery(Of Contact)(queryString, _
    context, MergeOption.NoTracking)

Dim contact As Contact = _
contactQuery.Include("SalesOrderHeader.SalesOrderDetail") _
    .FirstOrDefault()

// Define an object query with a path that returns 
// orders and items for a specific contact.              
string queryString =
    @"SELECT VALUE TOP(1) Contact FROM " + 
    "AdventureWorksEntities.Contact AS Contact";

// Define the object query with the query string.
ObjectQuery<Contact> contactQuery = new ObjectQuery<Contact>(queryString, 
    context, MergeOption.NoTracking);

Contact contact =
    contactQuery.Include("SalesOrderHeader.SalesOrderDetail")
    .FirstOrDefault();

クエリビルダメソッド

' Create an object query with a path that returns orders and items for a contact.
Dim contact As Contact = _
    context.Contact.Include("SalesOrderHeader.SalesOrderDetail") _
    .FirstOrDefault()

// Define an object query with a path that returns 
// orders and items for a specific contact.
Contact contact =
    context.Contact.Include("SalesOrderHeader.SalesOrderDetail")
    .FirstOrDefault();

クエリパスを定義する際は、次の点に注意してください。

クエリパスは、クエリビルダメソッドおよび LINQ クエリで使用できます。
Include を呼び出した場合、クエリパスは ObjectQuery の返されたインスタンスでのみ有効です。ObjectQuery の他のインスタンスとオブジェクトコンテキスト自体は影響を受けません。

Include はクエリオブジェクトを返すので、このメソッドを ObjectQuery で複数回呼び出すことで、次の例のように複数のリレーションシップのオブジェクトを含めることができます。

' Create a SalesOrderHeader query with two query paths, 
' one that returns order items and a second that returns the 
' billing and shipping addresses for each order.
Dim query As ObjectQuery(Of SalesOrderHeader) = _
    context.SalesOrderHeader.Include("SalesOrderDetail").Include("Address")

// Create a SalesOrderHeader query with two query paths, 
// one that returns order items and a second that returns the 
// billing and shipping addresses for each order.
ObjectQuery<SalesOrderHeader> query =
    context.SalesOrderHeader.Include("SalesOrderDetail").Include("Address");

クエリパスを使用すると、見かけ上は簡単なオブジェクトクエリのデータソースに対して複雑なコマンドが実行される可能性があります。これは、1 つのクエリ内の関連オブジェクトを返すには、1 つまたは複数の結合が必要になるために発生します。継承を備えたエンティティや多対多のリレーションシップを含んだパスなど、複雑な EDM に対してクエリを実行する場合は、さらに複雑になります。ObjectQuery によって生成されるコマンドを表示するには、ToTraceString メソッドを使用します。詳細については、「オブジェクトクエリ (Entity Framework)」を参照してください。クエリパスに含まれる関連オブジェクトが多すぎる場合や、オブジェクトに含まれる行データが多すぎる場合、データソースはクエリを完了できないことがあります。これは、クエリでデータソースの機能を超える中間一時ストレージが必要になる場合に発生します。この場合は、関連オブジェクトを明示的に読み込むと、データソースクエリの複雑さを軽減できます。

詳細については、「クエリパスを使用して結果を構築する方法 (Entity Framework)」を参照してください。

参照

概念

オブジェクトとしてのデータのクエリ (Entity Framework)
オブジェクトクエリ (Entity Framework)
クエリビルダメソッド (Entity Framework)

クエリ結果の構造化 (Entity Framework)

クエリ結果を構造化するためのクエリパスの定義

関連オブジェクトの明示的な読み込み

関連オブジェクトのクエリ

参照

概念

その他のリソース

クエリ結果の構造化 (Entity Framework)

クエリ結果を構造化するためのクエリ パスの定義

関連オブジェクトの明示的な読み込み

関連オブジェクトのクエリ

参照

概念

その他のリソース

クエリ結果を構造化するためのクエリパスの定義