In this article, we are going to learn about LINQ (Language Integrated Query) in C#. We are going to see why we should use LINQ in our codebase, and different ways to implement and execute LINQ queries. Furthermore, we will explore some of the frequently used LINQ queries.
Let’s dive in.
What is LINQ?
LINQ is a uniform query language, introduced with .NET 3.5 that we can use to retrieve data from different data sources. These data sources include the collection of objects, relational databases, ADO.NET datasets, XML files, etc.
Different Steps of a LINQ Query Operation
Let’s explore the three distinct steps of a LINQ query operation:
- Obtain the data source
- Create the query
- Execute the query
Obtain the Data Source
A valid LINQ data source must support the IEnumerable<T>
interface or an interface that inherits from it.
So, let’s define a simple data source:
var studentIds = new int[10] { 0, 1, 2, 3, 4, 5, 6, 7, 8, 9 };
The studentIds
is an array and it supports the IEnumerable<T>
interface.
Types that support IEnumerable<T>
or a derived interface (IQueryable<T>
) are called queryable types. A queryable type can directly be applied as a LINQ data source. However, if the data source is not represented in memory as a queryable type, we have to use LINQ
providers to load it to a queryable form.
Create the Query
A query specifies what information we want to retrieve from the data source.
To create a query, we have to import LINQ into our code:
using System.Linq;
Let’s now define the query:
var studentsWithEvenIds = from studentId in studentIds where (studentId % 2) == 0 select studentId;
Here, we are returning the IEnumerable<int>
collection named studentsWithEvenIds
. It holds all the even-numbered student ids.
The query expression has three clauses. The from
, where
and select
. The from
clause describes the data source. The where
clause applies filters and the select
clause produces the result of the query by shaping the data.
We have to pay attention to one important fact – we are not executing the query yet.
Execute the Query
There are two ways to execute a LINQ query:
- Deferred Execution
- Immediate Execution
Deferred Execution
We differ the actual execution of our previous query until we iterate over it using a foreach
statement. This concept is called deferred execution or lazy loading:
foreach (int studentId in studentsWithEvenIds) { Console.Write("Student Id {0} which is even.", studentId); }
Immediate Execution
Immediate execution is completely the opposite of deferred execution. Here, we execute our query and get the result immediately. Aggregate functions such as Count
, Average
, Min
, Max
, Sum,
and element operators such as First
, Last
, SingleToList
, ToArray
, ToDictionary
are some examples.
We are going to see these functions in action in the rest of the article.
Basic Ways to Write LINQ Queries
There are two basic ways to write LINQ queries:
- Query Syntax
- Method Syntax
Query Syntax
To start with our example, we are going to define a method that returns our data source:
static IQueryable<Student> GetStudentsFromDb() { return new[] { new Student() { StudentID = 1, StudentName = "John Nigel", Mark = 73, City ="NYC"} , new Student() { StudentID = 2, StudentName = "Alex Roma", Mark = 51 , City ="CA"} , new Student() { StudentID = 3, StudentName = "Noha Shamil", Mark = 88 , City ="CA"} , new Student() { StudentID = 4, StudentName = "James Palatte" , Mark = 60, City ="NYC"} , new Student() { StudentID = 5, StudentName = "Ron Jenova" , Mark = 85 , City ="NYC"} }.AsQueryable(); }
We are going to use a LINQ query syntax to find all the students with Mark
higher than 80:
var studentList = GetStudentsFromDb(); var highPerformingStudents = from student in studentList where student.Mark > 80 select student;
The query syntax starts with a from
clause. Thereafter, we can use any standard query operator to join, group, or filter the result. In this example, we use where
as the standard query operator. The query syntax ends with either a select
or a groupBy
clause.
Method Syntax
Method syntax use extension methods provided in the Enumerable
and Queryable
classes.
To see that syntax in action, let’s create another query:
var highPerformingStudents = studentList.Where(s => s.Mark > 80);
In this example, we are using the Where()
extension method and provide a lambda expression s => s.Mark > 80
as an argument.
Lambda Expressions With LINQ
In LINQ, we use lambda expressions in a convenient way to define anonymous functions. It is possible to pass a lambda expression as a variable or as a parameter to a method call. However, in many LINQ methods, lambda expressions are used as a parameter. As a result, it makes the syntax short, and precise. Its scope is limited to where it is used as an expression. Therefore, we are not able to reuse it afterward.
To see Lambda expression in play, let’s create a query:
var firstStudent = studentList.Select(x => x.StudentName);
The expression x => x.StudentName
is a lambda expression. x
here is an input parameter to the anonymous function representing each object inside the collection.
Frequently Used LINQ Methods
Since we’ve already seen the Where
method in action, let’s take a look at the other top LINQ methods we use in our everyday C# programming.
Sorting: OrderBy, OrderByDecending
We can use the OrderBy()
method to sort a collection in ascending order based on the selected property:
var selectStudentsWithOrderById = studentList.OrderBy(x => x.StudentID);
Similar to OrderBy()
method, the OrderByDescending()
method sorts the collection using the StudentID
property in descending order:
var selectStudentsWithOrderByDescendingId = studentList.OrderByDescending(x => x.StudentID);
Projection: Select
We use the Select
method to project each element of a sequence into a new form:
var studentsIdentified = studentList.Where(c => c.StudentName == name) .Select(stu => new Student {StudentName = stu.StudentName , Mark = stu.Mark});
Here, we filter only the students with the required name and then use the projection Select
method to return students with only StudentName
and Mark
properties populated. This way, we can easily extract only the required information from our objects.
Grouping: GroupBy
We can use the GroupBy()
method to group elements based on the specified key selector function. In this example, we are using City
:
var studentListGroupByCity = studentList.GroupBy(x => x.City);
One thing to mention. All the previous methods (Where, OrderBy, OrderByDescending, Select, GroupBy) return collection as a result. So, in order to use all the data inside the collection, we have to iterate over it.
All, Any, Contains
We can use All()
to determine whether all elements of a sequence satisfy a condition:
var hasAllStudentsPassed = studentList.All(x => x.Mark > 50);
Similarly, we can use Any()
to determine if any element of a sequence exists or satisfies a condition:
var hasAnyStudentGotDistinction = studentList.Any(x => x.Mark > 86);
The Contains()
method determines whether a sequence or a collection contains a specified element:
var studentContainsId = studentList.Contains(new Student { StudentName = "Noha Shamil"}, new StudentNameComparer());
Partitioning: Skip, Take
Skip()
will bypass a specified number of elements in a sequence and return the remaining elements:
var skipStuentsUptoIndexTwo = studentList.Skip(2);
Take()
will return a specified number of elements from the first element in a sequence:
var takeStudentsUptoIndexTwo = studentList.Take(2);
Aggregation: Count, Max, Min, Sum, Average
Applying the Sum()
method on the property Mark
will give the summation of all marks:
var sumOfMarks = studentList.Sum(x => x.Mark);
We can use the Count()
method to return the number of students with a score higher than 65:
var countOfStudents = studentList.Count(x => x.Mark > 65);
Max()
will display the highest Mark
scored by a student from the collection:
var maxMarks = studentList.Max(x => x.Mark);
Min()
will display the lowest marks scored by a student from the collection:
var minMarks = studentList.Min(x => x.Mark);
We can use Average()
to compute the average of a sequence of numerical values:
var avgMarks = studentList.Average(x => x.Mark);
Elements: First, FirstOrDefault, Single, SingleOrDefault
First()
returns the first element in the list that satisfies the predicate
function. However, if the input sequence is null it throws the ArgumentNullException
and if there’s no element for a condition it throws InvalidOperationException
:
var firstStudent = studentList.First(x => x.StudentID % 2 == 0);
FirstOrDefault()
works similarly to the First()
method for positive use cases. If there’s no element found it will return null
for reference types and a default value for the value types:
var firstOrDefaultStudent = studentList.FirstOrDefault(x => x.StudentID == 1);
Single()
method returns only one element in the collection after satisfying the condition. It also throws the same exceptions as the First()
method if the source or predicate is null, or if more than one element satisfies the condition of the predicate:
var singleStudent = studentList.Single(x => x.StudentID == 1);
SingleOrDefault()
method works similar to Single()
when we find the required element. But if we can’t find an element that meets our condition, the method will return null
for reference type or the default value for value types:
var singleOrDefaultStudent = studentList.SingleOrDefault(x => x.StudentID == 1);
Advantages and Disadvantages of Using LINQ
Let’s check some advantages of using LINQ:
- Improves code readability
- Provides compile-time object type-checking
- Provides IntelliSense support for generic collection
- LINQ queries can be reused
- Provides in-built methods to write less code and expedite development
- Provides common query syntax for various data sources
There are also disadvantages of using LINQ:
- Difficult to write complex queries as SQL
- Performance degradation if queries are not written accurately
- Require to recompile, and redeploy every time a change is made to the query
- Doesn’t take full advantage of SQL features such as cached execution plan for stored procedure
Conclusion
In this article, we’ve learned about LINQ in C#, the three parts of query operations, different ways to implement LINQ queries, and how to use LINQ queries in our codebase. So, this would be enough to get you started with using LINQ in your projects.
Helpful. great post.