This documentation is archived and is not being maintained.

ObjectQuery<T>.GroupBy Method

Groups the query results by the specified criteria.

Namespace:  System.Data.Objects
Assembly:  System.Data.Entity (in System.Data.Entity.dll)

public ObjectQuery<DbDataRecord> GroupBy(
	string keys,
	string projection,
	params ObjectParameter[] parameters
)

Parameters

keys
Type: System.String

The key columns by which to group the results.

projection
Type: System.String

The list of selected properties that defines the projection.

parameters
Type: System.Data.Objects.ObjectParameter[]

Zero or more parameters that are used in this method.

Return Value

Type: System.Data.Objects.ObjectQuery<DbDataRecord>
A new ObjectQuery<T> instance of type DbDataRecord that is equivalent to the original instance with GROUP BY applied.

ExceptionCondition
ArgumentNullException

The query parameter is null or an empty string.

-or-

The projection parameter is null or an empty string.

GroupBy applies the projection specified by the projection parameter. This means that the ObjectQuery<T> returned by the GroupBy method is always of type DbDataRecord. For more information, see Object Queries (Entity Framework).

This example is based on the Adventure Works Sales Model.

This example creates a new ObjectQuery<T> object that contains the results of the existing query grouped by product name.

    using (AdventureWorksEntities advWorksContext =
        new AdventureWorksEntities())
    {
        try
        {
            string queryString = @"SELECT VALUE Product 
                FROM AdventureWorksEntities.Product AS Product";

            ObjectQuery<Product> productQuery =
                new ObjectQuery<Product>(queryString,
                    advWorksContext, MergeOption.NoTracking);

            ObjectQuery<DbDataRecord> productQuery2 =
                productQuery.GroupBy("it.name AS pn",
                "Sqlserver.COUNT(it.Name) as count, pn");

            // Iterate through the collection of Products 
            // after the GroupBy method was called. 
            foreach (DbDataRecord result in productQuery2)
            {
                Console.WriteLine("Name: {0}; Count: {1}",
                    result["pn"], result["count"]);
            }
        }
        catch (EntitySqlException ex)
        {
            Console.WriteLine(ex.ToString());
        }
    }            
}

This example returns a set of nested data records that contain the Contact.LastName column, grouped and sorted alphabetically by the first letter of Contact.LastName.

using (AdventureWorksEntities advWorksContext =
    new AdventureWorksEntities())
{
    try
    {
        // Define the query with a GROUP BY clause that returns 
        // a set of nested LastName records grouped by first letter.
        ObjectQuery<DbDataRecord> query =
            advWorksContext.Contact
            .GroupBy("SUBSTRING(it.LastName, 1, 1) AS ln", "ln")    
            .Select("it.ln AS ln, (SELECT c1.LastName " +
            "FROM AdventureWorksEntities.Contact AS c1 " +
            "WHERE SubString(c1.LastName, 1, 1) = it.ln) AS CONTACT")
            .OrderBy("it.ln");

        // Execute the query and walk through the nested records. 
        foreach (DbDataRecord rec in
            query.Execute(MergeOption.AppendOnly))
        {
            Console.WriteLine("Last names that start with the letter '{0}':",
                        rec[0]);
            List<DbDataRecord> list = rec[1] as List<DbDataRecord>;
            foreach (DbDataRecord r in list)
            {
                for (int i = 0; i < r.FieldCount; i++)
                {
                    Console.WriteLine("   {0} ", r[i]);
                }
            }
        }
    }
    catch (EntitySqlException ex)
    {
        Console.WriteLine(ex.ToString());
    }
}

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.

.NET Framework

Supported in: 3.5 SP1
Show: