The Four Deadly Sins of LINQ Data Access: Part 2–Too Many Columns

By February 28, 2014 Uncategorized No Comments

Introduction

Last time I talked about the sin of Overly Chatty Queries and pointed out two other sins while showing an example of an Overly Chatty Query and how to fix it. One of those sins was the sin of Too Many Columns, and that’s what I’m going to discuss this time.

Confession

Here is the code snippet I showed last time which demonstrates how to eagerly load entities, ensuring you have all the data you need in a single query rather than requiring an additional query per loop iteration:

01.var orders =
02.    from order in Orders.Include(o => o.Customer) // Alternately, Orders.Include("Customer")
03.    where order.ShipCountry == "USA"
04.    select order;
05.    
06.foreach (var order in orders)
07.{
08.    Console.WriteLine(order.Customer.ContactName);
09.}

As I said back then, this query does repent of being Overly Chatty, but it is still selecting too many columns. The loop below only uses and needs Customer.ContactName, but the entire Customer table was included in the query results in order to fully populate Customer objects. For illustration, here is the generated SQL that results from executing these statements:

SELECT
[Extent1].[OrderID] AS [OrderID],
[Extent1].[CustomerID] AS [CustomerID],
[Extent1].[EmployeeID] AS [EmployeeID],
[Extent1].[OrderDate] AS [OrderDate],
[Extent1].[RequiredDate] AS [RequiredDate],
[Extent1].[ShippedDate] AS [ShippedDate],
[Extent1].[ShipVia] AS [ShipVia],
[Extent1].[Freight] AS [Freight],
[Extent1].[ShipName] AS [ShipName],
[Extent1].[ShipAddress] AS [ShipAddress],
[Extent1].[ShipCity] AS [ShipCity],
[Extent1].[ShipRegion] AS [ShipRegion],
[Extent1].[ShipPostalCode] AS [ShipPostalCode],
[Extent1].[ShipCountry] AS [ShipCountry],
[Extent2].[CustomerID] AS [CustomerID1],
[Extent2].[CompanyName] AS [CompanyName],
[Extent2].[ContactName] AS [ContactName],
[Extent2].[ContactTitle] AS [ContactTitle],
[Extent2].[Address] AS [Address],
[Extent2].[City] AS [City],
[Extent2].[Region] AS [Region],
[Extent2].[PostalCode] AS [PostalCode],
[Extent2].[Country] AS [Country],
[Extent2].[Phone] AS [Phone],
[Extent2].[Fax] AS [Fax]
FROM  [dbo].[Orders] AS [Extent1]
LEFT OUTER JOIN [dbo].[Customers] AS [Extent2] ON [Extent1].[CustomerID] = [Extent2].[CustomerID]
WHERE N'USA' = [Extent1].[ShipCountry]

Including all those unused columns means more work for SQL Server, more data being transmitted over the network, and more memory usage in .NET, all of which add up to reduced performance and scalability.

Repentence

The solution is quite simple: only request the columns you plan to use, like this:

01.var orders =
02.    from order in Orders
03.    where order.ShipCountry == "USA"
04.    select new { order.OrderID, order.Customer.ContactName };
05.    
06.foreach (var order in orders)
07.{
08.    Console.WriteLine(order.ContactName);
09.}

This results in a much smaller SQL query:

SELECT
[Extent1].[OrderID] AS [OrderID],
[Extent2].[ContactName] AS [ContactName]
FROM  [dbo].[Orders] AS [Extent1]
LEFT OUTER JOIN [dbo].[Customers] AS [Extent2] ON [Extent1].[CustomerID] = [Extent2].[CustomerID]
WHERE N'USA' = [Extent1].[ShipCountry]

Indulgence

“But”, some of you are probably thinking, “We use the Repository Pattern to separate our data access code and we don’t want to have a million different methods returning a million different combinations of columns, not to mention all of the extra classes you would have to define in order to be able to pass these custom projections back to the caller!” Fair enough. This is probably the kind of thing you were imagining:

01.void Main()
02.{
03.    using (var repository = new OrderRepository(this))
04.    {
05.        var orders = repository.GetOrderContacts("USA");       
06.        
07.        foreach (var order in orders)
08.        {
09.            Console.WriteLine(order.ContactName);
10.        }
11.    }
12.}
13. 
14.public class OrderRepository : IDisposable
15.{
16.    private NorthwindEntities context;
17.     
18.    public OrderRepository(NorthwindEntities context)
19.    {
20.        this.context = context;
21.    }
22.    private bool disposed = false;
23.     
24.    protected virtual void Dispose(bool disposing)
25.    {
26.        if (!this.disposed)
27.        {
28.            if (disposing)
29.            {
30.                context.Dispose();
31.            }
32.        }
33.        this.disposed = true;
34.    }
35.     
36.    public void Dispose()
37.    {
38.        Dispose(true);
39.        GC.SuppressFinalize(this);
40.    }
41.     
42.    /*
43.    Create one method for each custom projection
44.    */
45.    public IEnumerable<OrderContactName> GetOrderContacts(string shipCountry)
46.    {
47.        return (
48.            from order in context.Orders
49.            where order.ShipCountry == shipCountry
50.            select new OrderContactName { OrderID = order.OrderID, ContactName = order.Customer.ContactName }
51.        ).ToList();
52.    }
53.}
54. 
55./*
56.Create one data class for each custom projection
57.*/
58.public class OrderContactName
59.{
60.    public int OrderID { get; set; }
61.    public string ContactName { get; set; }
62.}

I can see at least three objections to doing things this way:

  1. Proliferation of data classes, requiring more code to be written and maintained
  2. Proliferation of specialized methods in the repository
  3. Possible duplication of query logic within the repository, only with different outputs

But there is a better way, thanks to the magic of generic type parameters! In summary, you declare your repository methods with a generic type parameter and return a collection of that type. Then, you pass a function that accepts a IQueryable of the base type and returns an IQueryable of the generic type. Here, sometimes it’s clearer just to show the code. Here’s the new repository method:

1.public IEnumerable<TResult> GetOrderContacts<TResult>(string shipCountry, Func<IQueryable<Order>, IQueryable<TResult>> transform)
2.{
3.    return transform(
4.        from order in context.Orders
5.        where order.ShipCountry == shipCountry
6.        select order
7.    ).ToList();
8.}

And this is how you would call it:

1.var orders = repository.GetOrderContacts("USA", os => os.Select (o => new { o.OrderID, o.Customer.ContactName }));

This has the following benefits:

  1. No extra data classes
  2. No extra repository methods
  3. No duplication of repository query logic

Next time, I’ll circle back to the topic of Underly Chatty Calls. Yes, there is such a thing! Now, go forth and select Too Many Columns no more!

 

The following two tabs change content below.
Adam Anderson is a Microsoft Certified Solution Developer with over 19 years of experience. He started as a consultant using Delphi to rapidly deliver custom, high-quality business solutions in a wide variety of industries. His later experiences afforded him the opportunity to become familiar with a number of different products, technologies, and disciplines, including SQL Server and T-SQL, Oracle and PL/SQL, Crystal Reports, SQL Reporting Services, Internet Information Services, .NET Framework, LINQ, Entity Framework, CSS, HTML, Javascript, Kendo UI, ASP.NET MVC & Web API, ServiceStack, Command batch files, PowerShell, normalized relational database design, dynamic databases, and good object-oriented design based on design patterns and refactoring.