How To Avoid the Boxing Penalty When You Use the DataReader in Visual C# .NET (312855)

SUMMARY

This article describes how to use the Getxxx methods (such as GetChar, GetDouble, and GetInt32) to avoid the boxing penalty when you use the DataReader object.

back to the top

Description of the Technique

When you use the Item property to read columns from a DataReader, the values are boxed and then unboxed. If the values are repeatedly boxed and unboxed, the heap quickly fills and increases the frequency of garbage collections. This also slightly impacts performance because Microsoft Visual Studio .NET converts and copies data more than necessary.

NOTE: Boxing means that the data is copied onto the heap as System.Object. When you cast to a specific data type, the values are unboxed and copied onto your variables on the stack or into another object.

To avoid the boxing penalty, use the Getxxx methods (such as GetChar, GetDouble, and GetInt32) that return the data as a simple data type instead of as System.Object.

NOTE: The Item property is the indexer for the SqlDataReader class in Visual C# .NET

back to the top

Requirements

The following list outlines the recommended hardware, software, network infrastructure, and service packs that you need:

• Microsoft Windows 2000 Professional, Windows 2000 Server, Windows 2000 Advanced Server, or Windows NT 4.0 Server
• Microsoft Visual Studio .NET

This article assumes that you are familiar with the following topics:

• Visual Studio .NET
• ADO.NET fundamentals and syntax

back to the top

Create Project and Add Code

1. Start Visual Studio .NET.
2. Create a new Windows Application project in Visual C# .NET. By default, Form1 is added to the project.
3. Make sure that your project contains a reference to the System.Data namespace, and add a reference to this namespace if it does not.
4. Add a Command button to Form1. Change the Name property of the button to btnTest, and change the Text property to Test.
5. Use the using statement on the System, System.Data, and System.Data.SqlClient namespaces so that you do not have to qualify declarations in those namespaces later in your code. Add the following code to the General Declarations section of Form1:

   using System;
   using System.Data.OleDb;
   using System.Data.SqlClient;
   					

6. Add the following code in the btnTest_Click event:

       String myConnString =
           "User ID=myUid;password=myPwd;Initial Catalog=Northwind;Data Source=myServer";
       String mySelectQuery =
           "Select * From Customers";
       SqlConnection con = new SqlConnection(myConnString);
       SqlCommand myCommand = new SqlCommand(mySelectQuery, con);
           
       con.Open();
       SqlDataReader myReader = myCommand.ExecuteReader();
       String str1 = "";
   
       while(myReader.Read())
       {
           //This code uses the GetString method.
           //str1 = str1 + myReader.GetString(0) + ", ";
           //This code uses the Indexer for myReader.
           str1 = str1 + myReader[0] + ", ";
       }
       
       MessageBox.Show(str1);
   
       myReader.Close();
       con.Close();
   					

7. Modify the connection string (myConnString) as appropriate for your environment.
8. Save your project. On the Debug menu, click Start to run your project.
9. Click Test. Notice that the query uses one of the methods (GetString or Item) to return data, and the message boxes display this data.
10. To compare the difference in performance or to time the code, use the QueryPerformanceCounter function to time application code. For more information about QueryPerformanceCounter, see the REFERENCES section.

back to the top

Troubleshooting

The disadvantage of using the Getxxx method is that you must check for NULL before you access the field. To check for NULL, use the IsDBNull method.

back to the top

REFERENCES

For more information about ADO.NET objects and syntax, see the following topic in the Microsoft .NET Framework Software Development Kit (SDK) documentation or MSDN Online: For additional information about how to use QueryPerformanceCounter to time code in Visual Basic .NET, click the article number below to view the article in the Microsoft Knowledge Base: back to the top