Home > Articles > Programming > Windows Programming

Designing APIs Related to LINQ Support

This excerpt provides a very brief overview of LINQ and list guidelines for designing APIs related to LINQ support, including the so-called Query Pattern.
This chapter is from the book

9.6 LINQ Support

Writing applications that interact with data sources, such as databases, XML documents, or Web Services, was made easier in the .NET Framework 3.5 with the addition of a set of features collectively referred to as LINQ (Language-Integrated Query). The following sections provide a very brief overview of LINQ and list guidelines for designing APIs related to LINQ support, including the so-called Query Pattern.

9.6.1 Overview of LINQ

Quite often, programming requires processing over sets of values. Examples include extracting the list of the most recently added books from a database of products, finding the e-mail address of a person in a directory service such as Active Directory, transforming parts of an XML document to HTML to allow for Web publishing, or something as frequent as looking up a value in a hashtable. LINQ allows for a uniform language-integrated programming model for querying datasets, independent of the technology used to store that data.

In terms of concrete language features and libraries, LINQ is embodied as:

  • A specification of the notion of extension methods. These are described in detail in section 5.6.
  • Lambda expressions, a language feature for defining anonymous delegates.
  • New types representing generic delegates to functions and procedures: Func<...> and Action<...>.
  • Representation of a delay-compiled delegate, the Expression<...> family of types.
  • A definition of a new interface, System.Linq.IQueryable<T>.
  • The Query Pattern, a specification of a set of methods a type must provide in order to be considered as a LINQ provider. A reference implementation of the pattern can be found in System.Linq.Enumerable class. Details of the pattern will be discussed later in this chapter.
  • Query Expressions, an extension to language syntax allowing for queries to be expressed in an alternative, SQL-like format.
    //using extension methods:
    var names = set.Where(x => x.Age>20).Select(x=>x.Name);
    //using SQL-like syntax:
    var names = from x in set where x.Age>20 select x.Name;

9.6.2 Ways of Implementing LINQ Support

There are three ways by which a type can support LINQ queries:

  • The type can implement IEnumerable<T> (or an interface derived from it).
  • The type can implement IQueryable<T>.
  • The type can implement the Query Pattern.

The following sections will help you choose the right method of supporting LINQ.

9.6.3 Supporting LINQ through IEnumerable<T>

check.jpg DO implement IEnumerable<T> to enable basic LINQ support.

Such basic support should be sufficient for most in-memory datasets. The basic LINQ support will use the extension methods on IEnumerable<T> provided in the .NET Framework. For example, simply define as follows:

public class RangeOfInt32s : IEnumerable<int> {
   public IEnumerator<int> GetEnumerator() {...}
   IEnumerator IEnumerable.GetEnumerator() {...}

Doing so allows for the following code, despite the fact that RangeOfInt32s did not implement a Where method:

var a = new RangeOfInt32s();
var b = a.Where(x => x>10);

check.jpg CONSIDER implementing ICollection<T> to improve performance of query operators.

For example, the System.Linq.Enumerable.Count method's default implementation simply iterates over the collection. Specific collection types can optimize their implementation of this method, since they often offer an O(1) – complexity mechanism for finding the size of the collection.

check.jpg CONSIDER supporting selected methods of System.Linq.Enumerable or the Query Pattern (see section 9.6.5) directly on new types implementing IEnumerable<T> if it is desirable to override the default System.Linq.Enumerable implementation (e.g., for performance optimization reasons).

9.6.4 Supporting LINQ through IQueryable<T>

check.jpg CONSIDER implementing IQueryable<T> when access to the query expression, passed to members of IQueryable, is necessary.

When querying potentially large datasets generated by remote processes or machines, it might be beneficial to execute the query remotely. An example of such a dataset is a database, a directory service, or Web service.

cross.jpg DO NOT implement IQueryable<T> without understanding the performance implications of doing so.

Building and interpreting expression trees is expensive, and many queries can actually get slower when IQueryable<T> is implemented.

The trade-off is acceptable in the LINQ to SQL case, since the alternative overhead of performing queries in memory would have been far greater than the transformation of the expression to an SQL statement and the delegation of the query processing to the database server.

check.jpg DO throw NotSupportedException from IQueryable<T> methods that cannot be logically supported by your data source.

For example, imagine representing a media stream (e.g., an Internet radio stream) as an IQueryable<byte>. The Count method is not logically supported—the stream can be considered as infinite, and so the Count method should throw NotSupportedException.

9.6.5 Supporting LINQ through the Query Pattern

The Query Pattern refers to defining the methods in Figure 9-1 without implementing the IQueryable<T> (or any other LINQ interface).

Figure 9-1. Query Pattern Method Signatures

S<T> Where(this S<T>, Func<T,bool>)

S<T2> Select(this S<T1>, Func<T1,T2>)
S<T3> SelectMany(this S<T1>, Func<T1,S<T2>>, Func<T1,T2,T3>)
S<T2> SelectMany(this S<T1>, Func<T1,S<T2>>)

O<T> OrderBy(this S<T>, Func<T,K>), where K is IComparable
O<T> ThenBy(this O<T>, Func<T,K>), where K is IComparable

S<T> Union(this S<T>, S<T>)
S<T> Take(this S<T>, int)
S<T> Skip(this S<T>, int)
S<T> SkipWhile(this S<T>, Func<T,bool>)

S<T3> Join(this S<T1>, S<T2>, Func<T1,K1>, Func<T2,K2>,

T ElementAt(this S<T>,int)

Please note that the notation is not meant to be valid code in any particular language but to simply present the type signature pattern.

The notation uses S to indicate a collection type (e.g., IEnumerable<T>, ICollection<T>), and T to indicate the type of elements in that collection. Additionally, we use O<T> to represent subtypes of S<T> that are ordered. For example, S<T> is a notation that could be substituted with IEnumerable<int>, ICollection<Foo>, or even MyCollection (as long as the type is an enumerable type).

The first parameter of all the methods in the pattern (marked with this) is the type of the object the method is applied to. The notation uses extension-method-like syntax, but the methods can be implemented as extension methods or as member methods; in the latter case the first parameter should be omitted, of course, and the this pointer should be used.

Also, anywhere Func<...> is being used, pattern implementations may substitute Expression<Func<...>> for it. You can find guidelines later that describe when that is preferable.

check.jpg DO implement the Query Pattern as instance members on the new type, if the members make sense on the type even outside of the context of LINQ. Otherwise, implement them as extension methods.

For example, instead of the following:

public class MyDataSet<T>:IEnumerable<T>{...}
public static class MyDataSetExtensions{
     public static MyDataSet<T> Where(this MyDataSet<T> data, Func<T,bool>

Prefer the following, because it's completely natural for datasets to support Where methods:

public class MyDataSet<T>:IEnumerable<T>{
     public MyDataSet<T> Where(Func<T,bool> query){...}

check.jpg DO implement IEnumerable<T> on types implementing the Query Pattern.

check.jpg CONSIDER designing the LINQ operators to return domain-specific enumerable types. Essentially, one is free to return anything from a Select query method; however, the expectation is that the query result type should be at least enumerable.

This allows the implementation to control which query methods get executed when they are chained. Otherwise, consider a user-defined type MyType, which implements IEnumerable<T>. MyType has an optimized Count method defined, but the return type of the Where method is IEnumerable<T>. In the example here, the optimization is lost after the Where method is called; the method returns IEnumerable<T>, and so the built-in Enumerable.Count method is called, instead of the optimized one defined on MyType.

var result = myInstance.Where(query).Count();

cross.jpg AVOID implementing just a part of the Query Pattern if fallback to the basic IEnumerable<T> implementations is undesirable.

For example, consider a user-defined type MyType, which implements IEnumerable<T>. MyType has an optimized Count method defined but does not have Where. In the example here, the optimization is lost after the Where method is called; the method returns IEnumerable<T>, and so the built-in Enumerable.Count method is called, instead of the optimized one defined on MyType.

var result = myInstance.Where(query).Count();

check.jpg DO represent ordered sequences as a separate type, from its unordered counterpart. Such types should define ThenBy method.

This follows the current pattern in the LINQ to Objects implementation and allows for early (compile-time) detection of errors such as applying ThenBy to an unordered sequence.

For example, the Framework provides the IOrderedEnumerable<T> type, which is returned by OrderBy. The ThenBy extension method is defined for this type, and not for IEnumerable<T>.

check.jpg DO defer execution of query operator implementations. The expected behavior of most of the Query Pattern members is that they simply construct a new object which, upon enumeration, produces the elements of the set that match the query.

The following methods are exceptions to this rule: All, Any, Average, Contains, Count, ElementAt, Empty, First, FirstOrDefault, Last, LastOrDefault, Max, Min, Single, Sum.

In the example here, the expectation is that the time necessary for evaluating the second line will be independent from the size or nature (e.g., in-memory or remote server) of set1. The general expectation is that this line simply prepares set2, delaying the determination of its composition to the time of its enumeration.

var set1 = ...
var set2 = set1.Select(x => x.SomeInt32Property);
foreach(int number in set2){...} // this is when actual work happens

check.jpg DO place query extensions methods in a "Linq" subnamespace of the main namespace. For example, extension methods for System.Data features reside in System.Data.Linq namespace.

check.jpg DO use Expression<Func<...>> as a parameter instead of Func<...> when it is necessary to inspect the query. See section 9.6.5 for more details.

As discussed earlier, interacting with an SQL database is already done through IQueryable<T> (and therefore expressions) rather than IEnumerable<T>, since this gives an opportunity to translate lambda expressions to SQL expressions.

An alternative reason for using expressions is performing optimizations. For example, a sorted list can implement look-up (Where clauses) with binary search, which can be much more efficient than the standard IEnumerable<T> or IQueryable<T> implementations.

InformIT Promotional Mailings & Special Offers

I would like to receive exclusive offers and hear about products from InformIT and its family of brands. I can unsubscribe at any time.


Pearson Education, Inc., 221 River Street, Hoboken, New Jersey 07030, (Pearson) presents this site to provide information about products and services that can be purchased through this site.

This privacy notice provides an overview of our commitment to privacy and describes how we collect, protect, use and share personal information collected through this site. Please note that other Pearson websites and online products and services have their own separate privacy policies.

Collection and Use of Information

To conduct business and deliver products and services, Pearson collects and uses personal information in several ways in connection with this site, including:

Questions and Inquiries

For inquiries and questions, we collect the inquiry or question, together with name, contact details (email address, phone number and mailing address) and any other additional information voluntarily submitted to us through a Contact Us form or an email. We use this information to address the inquiry and respond to the question.

Online Store

For orders and purchases placed through our online store on this site, we collect order details, name, institution name and address (if applicable), email address, phone number, shipping and billing addresses, credit/debit card information, shipping options and any instructions. We use this information to complete transactions, fulfill orders, communicate with individuals placing orders or visiting the online store, and for related purposes.


Pearson may offer opportunities to provide feedback or participate in surveys, including surveys evaluating Pearson products, services or sites. Participation is voluntary. Pearson collects information requested in the survey questions and uses the information to evaluate, support, maintain and improve products, services or sites, develop new products and services, conduct educational research and for other purposes specified in the survey.

Contests and Drawings

Occasionally, we may sponsor a contest or drawing. Participation is optional. Pearson collects name, contact information and other information specified on the entry form for the contest or drawing to conduct the contest or drawing. Pearson may collect additional personal information from the winners of a contest or drawing in order to award the prize and for tax reporting purposes, as required by law.


If you have elected to receive email newsletters or promotional mailings and special offers but want to unsubscribe, simply email information@informit.com.

Service Announcements

On rare occasions it is necessary to send out a strictly service related announcement. For instance, if our service is temporarily suspended for maintenance we might send users an email. Generally, users may not opt-out of these communications, though they can deactivate their account information. However, these communications are not promotional in nature.

Customer Service

We communicate with users on a regular basis to provide requested services and in regard to issues relating to their account we reply via email or phone in accordance with the users' wishes when a user submits their information through our Contact Us form.

Other Collection and Use of Information

Application and System Logs

Pearson automatically collects log data to help ensure the delivery, availability and security of this site. Log data may include technical information about how a user or visitor connected to this site, such as browser type, type of computer/device, operating system, internet service provider and IP address. We use this information for support purposes and to monitor the health of the site, identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents and appropriately scale computing resources.

Web Analytics

Pearson may use third party web trend analytical services, including Google Analytics, to collect visitor information, such as IP addresses, browser types, referring pages, pages visited and time spent on a particular site. While these analytical services collect and report information on an anonymous basis, they may use cookies to gather web trend information. The information gathered may enable Pearson (but not the third party web trend services) to link information with application and system log data. Pearson uses this information for system administration and to identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents, appropriately scale computing resources and otherwise support and deliver this site and its services.

Cookies and Related Technologies

This site uses cookies and similar technologies to personalize content, measure traffic patterns, control security, track use and access of information on this site, and provide interest-based messages and advertising. Users can manage and block the use of cookies through their browser. Disabling or blocking certain cookies may limit the functionality of this site.

Do Not Track

This site currently does not respond to Do Not Track signals.


Pearson uses appropriate physical, administrative and technical security measures to protect personal information from unauthorized access, use and disclosure.


This site is not directed to children under the age of 13.


Pearson may send or direct marketing communications to users, provided that

  • Pearson will not use personal information collected or processed as a K-12 school service provider for the purpose of directed or targeted advertising.
  • Such marketing is consistent with applicable law and Pearson's legal obligations.
  • Pearson will not knowingly direct or send marketing communications to an individual who has expressed a preference not to receive marketing.
  • Where required by applicable law, express or implied consent to marketing exists and has not been withdrawn.

Pearson may provide personal information to a third party service provider on a restricted basis to provide marketing solely on behalf of Pearson or an affiliate or customer for whom Pearson is a service provider. Marketing preferences may be changed at any time.

Correcting/Updating Personal Information

If a user's personally identifiable information changes (such as your postal address or email address), we provide a way to correct or update that user's personal data provided to us. This can be done on the Account page. If a user no longer desires our service and desires to delete his or her account, please contact us at customer-service@informit.com and we will process the deletion of a user's account.


Users can always make an informed choice as to whether they should proceed with certain services offered by InformIT. If you choose to remove yourself from our mailing list(s) simply visit the following page and uncheck any communication you no longer want to receive: www.informit.com/u.aspx.

Sale of Personal Information

Pearson does not rent or sell personal information in exchange for any payment of money.

While Pearson does not sell personal information, as defined in Nevada law, Nevada residents may email a request for no sale of their personal information to NevadaDesignatedRequest@pearson.com.

Supplemental Privacy Statement for California Residents

California residents should read our Supplemental privacy statement for California residents in conjunction with this Privacy Notice. The Supplemental privacy statement for California residents explains Pearson's commitment to comply with California law and applies to personal information of California residents collected in connection with this site and the Services.

Sharing and Disclosure

Pearson may disclose personal information, as follows:

  • As required by law.
  • With the consent of the individual (or their parent, if the individual is a minor)
  • In response to a subpoena, court order or legal process, to the extent permitted or required by law
  • To protect the security and safety of individuals, data, assets and systems, consistent with applicable law
  • In connection the sale, joint venture or other transfer of some or all of its company or assets, subject to the provisions of this Privacy Notice
  • To investigate or address actual or suspected fraud or other illegal activities
  • To exercise its legal rights, including enforcement of the Terms of Use for this site or another contract
  • To affiliated Pearson companies and other companies and organizations who perform work for Pearson and are obligated to protect the privacy of personal information consistent with this Privacy Notice
  • To a school, organization, company or government agency, where Pearson collects or processes the personal information in a school setting or on behalf of such organization, company or government agency.


This web site contains links to other sites. Please be aware that we are not responsible for the privacy practices of such other sites. We encourage our users to be aware when they leave our site and to read the privacy statements of each and every web site that collects Personal Information. This privacy statement applies solely to information collected by this web site.

Requests and Contact

Please contact us about this Privacy Notice or if you have any requests or questions relating to the privacy of your personal information.

Changes to this Privacy Notice

We may revise this Privacy Notice through an updated posting. We will identify the effective date of the revision in the posting. Often, updates are made to provide greater clarity or to comply with changes in regulatory requirements. If the updates involve material changes to the collection, protection, use or disclosure of Personal Information, Pearson will provide notice of the change through a conspicuous notice on this site or other appropriate way. Continued use of the site after the effective date of a posted revision evidences acceptance. Please contact us if you have questions or concerns about the Privacy Notice or any objection to any revisions.

Last Update: November 17, 2020