Click here to Skip to main content
15,122,406 members
Articles / Web Development / HTML
Article
Posted 20 Feb 2014

Stats

86.4K views
16 bookmarked

SingleOrDefault and FirstOrDefault Methods in LINQ to SQL

Rate me:
Please Sign up or sign in to vote.
4.92/5 (22 votes)
14 Jul 2014CPOL4 min read
This article explains the differences between the SingleOrDefault and FirstOrDefault Methods in LINQ to SQL.

Introduction

The SingleOrDefault() method returns a single specific element of a sequence or default value if that element is not found in the sequence. Whenever you use SingleOrDefault, you clearly state that the query should result in at most a single result.

The FirstOrDefault() method returns a first specific element of a sequence or default value if that element is not found in the sequence. Whenever FirstOrDefault is used, the query can return any amount of results, but you state that you only want the first one.

I create a console application to explain the differences between these methods.

Adding a LINQ to SQL Class

Entity classes are created and stored in LINQ to SQL Classes files (.dbml files). The O/R Designer opens when you open a .dbml file. It is a DataContext class that contains methods and properties for connecting to a database and manipulating the data in the database. The DataContext name corresponds to the name that you provided for the .dbml file

  • Step 1: Right-click on the project in the Solution Explorer, then go to "Add" and click on "Class.."
  • Step 2: Choose "LINQ to SQL Classes" from the list and give the name "User" for the dbml name. After that, click on "Add".
  • Step 3: Drag the User table from the database in the Server Explorer and drop onto the O/R Designer surface of the "User.dbml" file.

    Table in User.dbml file

    Figure 1.1: Table in User.dbml file

Using the Code

We will look at various scenarios for FirstOrDefault and SingleOrDefault methods. So let's see each one by one.

If Sequence Returns 0 Elements

If a sequence returns 0 elements, then the FirstOrDefault method sets the default value for the type. Suppose we are retrieving a specific record from the database table and that specific record does not exist in the database table, then the sequence contains 0 elements and the FirstOrDefault method sets a null value for that object.

In the following code snippet, the sequence does not contain an element, then the FirstOrDefault method sets a null value for the object type and the catch block executes. We define NullReferenceException as a parameter in the catch block that represents that this catch block executes when a null value is set for an object and data is being retrieved from that object.

C#
using System;
using System.Linq;

namespace FirstOrSingle
{
    class Program
    {
        static void Main(string[] args)
        {
            using (UserDataContext dataContext = new UserDataContext())
            {
                var users = from user in dataContext.Users
                            where user.Id==5
                           select user;

                var firstUser = users.FirstOrDefault();
                try
                {
                    Console.WriteLine("Name : {0} Age : {1}", firstUser.Name, firstUser.Age);             
                }
                catch(NullReferenceException ex)
                {              
                  Console.WriteLine("No Record Found");
                  Console.Write(ex.Message);            
                }
                Console.ReadKey();
            }
        }
    }
}

After running the application, we get the result that represents that the catch block executes due to retrieving a value from the object that has a null value.

Output of program when sequence contains zero element

Figure 1.2: Output of program when sequence contains zero element

We can implement the SingleOrDefault method on the same sequence that does not contain any elements; it then also sets a null value to the object.

C#
using System;
using System.Linq;

namespace FirstOrSingle
{
    class Program
    {
        static void Main(string[] args)
        {
            using (UserDataContext dataContext = new UserDataContext())
            {
                var users = from user in dataContext.Users
                            where user.Id==5
                           select user;

                var singleUser = users.SingleOrDefault();          

                try
                {
                    Console.WriteLine("Name : {0} Age : {1}", singleUser.Name, singleUser.Age);
                }
                catch(NullReferenceException ex)
                {                  

                    Console.WriteLine("No Record Found");
                    Console.Write(ex.Message);  
                }
                Console.ReadKey();
            }
        }
    }
}

We get the same result as in Figure 1.2 that represents that there is not a difference between the FirstOrDefault and SingleOrDefault methods when the sequence does not contain any elements.

If Sequence Contains 1 Element

If the sequence contains only 1 element, then there is no difference between the FirstOrDefault and SingleOrDefault methods, both will return the same one element. For example:

C#
using System;
using System.Linq; 

namespace FirstOrSingle
{
    class Program
    {
        static void Main(string[] args)
        {
            using (UserDataContext dataContext = new UserDataContext())
            {
                var users = from user in dataContext.Users
                            where user.Id==4
                           select user;

                var firstUser = users.FirstOrDefault();
                var singleUser = users.SingleOrDefault();
                try
                {

                    Console.WriteLine("Result By FirstOrDefault Method");
                    Console.WriteLine("Name : {0} Age : {1}", firstUser.Name, firstUser.Age);
                    Console.WriteLine("======================================================");
                    Console.WriteLine("Result By SingleOrDefault Method");
                    Console.WriteLine("Name : {0} Age : {1}", singleUser.Name, singleUser.Age); 
                }
                catch(NullReferenceException ex)
                {    
                    Console.Write(ex.Message);  
                }
                Console.ReadKey();
            }
        }
    }
}

After running the application, we get the result that represents the same result for both methods.

Output of program when sequence contains one element

Figure 1.3: Output of program when sequence contains one element

If the Sequence Contains Many Elements

If the sequence contains many elements, then the FirstOrDefault method returns only one element that is on top in the sequence. The following code snippet shows that the top one element is gotten from this sequence using the FirstOrDefault method.

C#
using System;
using System.Linq;

namespace FirstOrSingle
{
    class Program
    {
        static void Main(string[] args)
        {

            using (UserDataContext dataContext = new UserDataContext())
            {
                var users = from user in dataContext.Users 
                           select user;
                try
                {
                    var firstUser = users.FirstOrDefault();
                    Console.WriteLine("Name : {0} Age : {1}", firstUser.Name, firstUser.Age); 
                }
                catch(InvalidOperationException ex)
                {   
                    Console.Write(ex.Message); 
                }
                Console.ReadKey();
            }
        }
    }
} 

After running the application, we get the top first element from the sequence.

one element from the sequence when the sequence contains more than one

Figure 1.4: one element from the sequence when the sequence contains more than one

When the sequence contains many elements and uses the SingleOrDefault method to get an element, then we get an exception that represents that sequence containing more than one element. See the following code snippet:

C#
using System;
using System.Linq; 

namespace FirstOrSingle
{
    class Program
    {

        static void Main(string[] args)
        {
            using (UserDataContext dataContext = new UserDataContext())
            {
                var users = from user in dataContext.Users 
                           select user;              

                try
                {
                    var singleUser = users.SingleOrDefault();
                    Console.WriteLine("Name : {0} Age : {1}", singleUser.Name, singleUser.Age);
                }

                catch(InvalidOperationException ex)
                {
                    Console.Write(ex.Message);  
                }
                Console.ReadKey();
            }
        }
    }
} 

After running the application, we get the result that shows an exception which was created by the SingleOrDefault method due to the sequence that contains more than one element.

 Exception when sequence contains more than one element

Figure 1.5: Exception when sequence contains more than one element

Conclusion

If you want an exception to be thrown if the sequence contains more than one element, then use SingleOrDefault. If you always want one record no matter what the sequence contains, use FirstOrDefault.

License

This article, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)

Share

About the Author

Sandeep Singh Shekhawat
Software Developer
India India
He is awarded for Microsoft TechNet Guru, CodeProject MVP and C# Corner MVP. http://l-knowtech.com/

Comments and Discussions

 
GeneralMy vote of 5 Pin
darkliahos14-Mar-16 5:17
Memberdarkliahos14-Mar-16 5:17 
QuestionWhat is the LINQ query for getting all the data Pin
Mateen Kadwaikar28-Jan-15 3:09
MemberMateen Kadwaikar28-Jan-15 3:09 
QuestionWell done and very good explanation Pin
Salam Y. ELIAS2-Nov-14 2:23
professionalSalam Y. ELIAS2-Nov-14 2:23 
AnswerRe: Well done and very good explanation Pin
Sandeep Singh Shekhawat2-Nov-14 15:20
professionalSandeep Singh Shekhawat2-Nov-14 15:20 
QuestionSandeep Pin
Member 800608921-Jul-14 6:24
MemberMember 800608921-Jul-14 6:24 
AnswerRe: Sandeep Pin
Sandeep Singh Shekhawat21-Jul-14 6:59
professionalSandeep Singh Shekhawat21-Jul-14 6:59 
GeneralMy vote of 1 Pin
Samer Aburabie16-Jul-14 0:53
MemberSamer Aburabie16-Jul-14 0:53 
GeneralRe: My vote of 1 Pin
Sandeep Singh Shekhawat16-Jul-14 1:43
professionalSandeep Singh Shekhawat16-Jul-14 1:43 
GeneralMy vote of 5 Pin
Akhil Mittal 14-Jul-14 21:56
professional Akhil Mittal 14-Jul-14 21:56 
GeneralRe: My vote of 5 Pin
Sandeep Singh Shekhawat30-Aug-14 20:16
professionalSandeep Singh Shekhawat30-Aug-14 20:16 
QuestionMy vote of 5 Pin
Yogesh Kumar Tyagi14-Jul-14 19:36
professionalYogesh Kumar Tyagi14-Jul-14 19:36 
AnswerRe: My vote of 5 Pin
Sandeep Singh Shekhawat30-Aug-14 20:16
professionalSandeep Singh Shekhawat30-Aug-14 20:16 
GeneralRe: My vote of 5 Pin
Yogesh Kumar Tyagi31-Aug-14 19:12
professionalYogesh Kumar Tyagi31-Aug-14 19:12 
Most Welcome
GeneralMy vote of 5 Pin
kayesharun14-Jul-14 18:14
Memberkayesharun14-Jul-14 18:14 
GeneralRe: My vote of 5 Pin
Sandeep Singh Shekhawat14-Jul-14 18:25
professionalSandeep Singh Shekhawat14-Jul-14 18:25 
QuestionNo no no. Pin
Pete O'Hanlon20-Feb-14 10:00
mvePete O'Hanlon20-Feb-14 10:00 
AnswerRe: No no no. Pin
Sandeep Singh Shekhawat20-Feb-14 17:54
professionalSandeep Singh Shekhawat20-Feb-14 17:54 
QuestionIsn't it easier to say... Pin
Paulo Zemek20-Feb-14 10:00
mvaPaulo Zemek20-Feb-14 10:00 
AnswerRe: Isn't it easier to say... Pin
Sandeep Singh Shekhawat14-Jul-14 7:37
professionalSandeep Singh Shekhawat14-Jul-14 7:37 

General General    News News    Suggestion Suggestion    Question Question    Bug Bug    Answer Answer    Joke Joke    Praise Praise    Rant Rant    Admin Admin   

Use Ctrl+Left/Right to switch messages, Ctrl+Up/Down to switch threads, Ctrl+Shift+Left/Right to switch pages.