Queryable.GroupBy(Of TSource, TKey) Method (IQueryable(Of TSource), Expression(Of Func(Of TSource, TKey)))


Groups the elements of a sequence according to a specified key selector function.

Namespace:   System.Linq
Assembly:  System.Core (in System.Core.dll)

Public Shared Function GroupBy(Of TSource, TKey) (
	source As IQueryable(Of TSource),
	keySelector As Expression(Of Func(Of TSource, TKey))
) As IQueryable(Of IGrouping(Of TKey, TSource))


Type: System.Linq.IQueryable(Of TSource)

An IQueryable(Of T) whose elements to group.

Type: System.Linq.Expressions.Expression(Of Func(Of TSource, TKey))

A function to extract the key for each element.

Return Value

Type: System.Linq.IQueryable(Of IGrouping(Of TKey, TSource))

An IQueryable<IGrouping<TKey, TSource>> in C# or IQueryable(Of IGrouping(Of TKey, TSource)) in Visual Basic where each IGrouping(Of TKey, TElement) object contains a sequence of objects and a key.

Type Parameters


The type of the elements of source.


The type of the key returned by the function represented in keySelector.

Exception Condition

source or keySelector is null.

This method has at least one parameter of type Expression(Of TDelegate) whose type argument is one of the Func(Of T, TResult) types. For these parameters, you can pass in a lambda expression and it will be compiled to an Expression(Of TDelegate).

The GroupBy(Of TSource, TKey)(IQueryable(Of TSource), Expression(Of Func(Of TSource, TKey))) method generates a MethodCallExpression that represents calling GroupBy(Of TSource, TKey)(IQueryable(Of TSource), Expression(Of Func(Of TSource, TKey))) itself as a constructed generic method. It then passes the MethodCallExpression to the CreateQuery(Of TElement)(Expression) method of the IQueryProvider represented by the Provider property of the source parameter.

The query behavior that occurs as a result of executing an expression tree that represents calling GroupBy(Of TSource, TKey)(IQueryable(Of TSource), Expression(Of Func(Of TSource, TKey))) depends on the implementation of the type of the source parameter. The expected behavior is that it groups the elements of source by a key value that is obtained by invoking keySelector on each element.

The following code example demonstrates how to use GroupBy(Of TSource, TKey)(IQueryable(Of TSource), Expression(Of Func(Of TSource, TKey))) to group the elements of a sequence.

Structure Pet
    Public Name As String
    Public Age As Integer
End Structure

Shared Sub GroupByEx1()
    ' Create a list of Pet objects.
    Dim pets As New List(Of Pet)(New Pet() { _
                    New Pet With {.Name = "Barley", .Age = 8}, _
                    New Pet With {.Name = "Boots", .Age = 4}, _
                    New Pet With {.Name = "Whiskers", .Age = 1}, _
                    New Pet With {.Name = "Daisy", .Age = 4}})

    ' Group the pets using Pet.Age as the key.
    ' Use Pet.Name as the value for each entry.
    Dim query = pets.AsQueryable().GroupBy(Function(pet) pet.Age)

    Dim output As New System.Text.StringBuilder
    ' Iterate over each IGrouping in the collection.
    For Each ageGroup In query
        output.AppendFormat("Age group: {0}   Number of pets: {1}{2}", ageGroup.Key, ageGroup.Count(), vbCrLf)

    ' Display the output.
End Sub

' This code produces the following output:
' Age group: 8   Number of pets: 1
' Age group: 4   Number of pets: 2
' Age group: 1   Number of pets: 1

Universal Windows Platform
Available since 8
.NET Framework
Available since 3.5
Portable Class Library
Supported in: portable .NET platforms
Available since 2.0
Windows Phone Silverlight
Available since 7.1
Windows Phone
Available since 8.1
Return to top