.NET Framework Class Library
DataLoadOptions Class

Provides for immediate loading and filtering of related data.

Namespace:  System.Data.Linq
Assembly:  System.Data.Linq (in System.Data.Linq.dll)
Syntax

Visual Basic (Declaration)
Public NotInheritable Class DataLoadOptions
Visual Basic (Usage)
Dim instance As DataLoadOptions
C#
public sealed class DataLoadOptions
Visual C++
public ref class DataLoadOptions sealed
JScript
public final class DataLoadOptions
Remarks

General

When you query for an object, you actually retrieve only the object you requested. The related objects are not automatically fetched at the same time. (For more information, see Querying Across Relationships (LINQ to SQL).)

The DataLoadOptions class provides two methods to achieve immediate loading of specified related data. The LoadWith method allows for immediate loading of data related to the main target. The AssociateWith method allows for filtering related objects.

Rules

Note the following rules regarding DataLoadOptions usage:

  • Assigning a DataLoadOptions to a DataContext after the first query has been executed generates an exception.

  • Modifying a DataLoadOptions after it has been assigned to a DataContext generates an exception

Cycle Handling

LoadWith and AssociateWith directives must not create cycles. The following represent examples of such graphs:

  • Example 1: Self recursive

    • dlo.LoadWith<Employee>(e => e.Reports);

  • Example 2: Back-pointers

    • dlo.LoadWith <Customer>(c => C.Orders);

    • dlo.LoadWith <Order>(o => o.Customer);

  • Example 3: Longer cycles

    Although this should not occur in a well-normalized model, it is possible.

    • dlo.LoadWith <A>(a => a.Bs);

    • dlo.LoadWith <B>(b => b.Cs);

    • dlo.LoadWith <C>(c => c.As);

  • Example 4: Self recursive subQueries

    • dlo.AssociateWith<A>(a=>a.As.Where(a=>a.Id=33));

  • Example 5: Longer recursive subqueries

    • dlo.AssociateWith<A>(a=>a.Bs.Where(b=>b.Id==3));

    • dlo.AssociateWith<B>(b=>b.As.Where(a=>a.Id==3));

The following are some general rules that help you understand what occurs in these scenarios.

LoadWith Each call to LoadWith checks whether cycles have been introduced into the graph. If there are, as in Examples 1, 2, and 3, an exception is thrown.

AssociateWith The engine at run time does not apply the existing SubQuery clauses to the relationship inside the expression.

  • In Example 4, the Where clause is executed against all A, not just the ones sub-filtered by the SubQuery expression itself (because that would be recursive)

  • In Example 5, the first Where clause is applied to all the Bs, even though there are subqueries on B. The second Where clause is applied to all the As even though there are subqueries on A.

Examples

When you retrieve Customers from the Northwind sample database, you can use DataLoadOptions to specify that Orders is also to be retrieved. You can even specify which subset of Orders to retrieve.

Inheritance Hierarchy

System..::.Object
  System.Data.Linq..::.DataLoadOptions
Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Platforms

Windows 7, Windows Vista, Windows XP SP2, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Version Information

.NET Framework

Supported in: 3.5
See Also

Reference

Tags : linq2sql


Community Content

ricka0
What Schema is Self recursive?
Unless you define the schema - your sample doesn't imply recursive or Back-pointers. Please define cycle.
>>LoadWith Each call to
I think that's a typo.
Please provide source code (c# & VB to a working sample with AW or AWLT db's)
Tags :

Thomas Lee
Cycle?
The terminology used here ('cycle') is meaningless. The writer should not assume the reader knows what this is. Please define or link to a definition of cycle.

Page view tracker