Skip to main content

Pre-Generating Views in Entity Framework .NET 4.0

Image
By

 

UPDATED ON: 16/09/2010

If you’re using Entity Framework chances are you’ve come up against performance issues already, especially when instantiating your Object Context.

One very reliable way to increase performance is to pre-generate the Views. Depending on the size of your model and in my experience it can shave as much as 40% off the instantiation time.

There is a good overview on MSDN, however it only covers .NET 3.5.

Step 1

Go to your Model properties and select “Copy to Output Directory” for the Metadata Artifact Processing option.

ef-pre-generate

The result of this is you will end up with the .ssdl, .csdl and .msl files in your output directory which in this case is bin/Debug.

Step 2


Next you need to setup the Pre-build event to use the EDMGen.exe tool.
NB: If you use the Command on the MSDN site you will come across this error.

“The required parameter ‘mode’ is missing”

The correct command to use is: 

"%windir%\Microsoft.NET\Framework\v4.0.30319\EdmGen.exe" /mode:ViewGeneration "/inssdl:$(TargetDir)MyModel.ssdl" "/incsdl:$(TargetDir)MyModel.csdl" "/inmsl:$(TargetDir)MyModel.msl" "/outviews:$(ProjectDir)MyModel.Views.cs" /nologo /language:CSharp

 

Step 3

The .ssdl, .csdl & .msl files will be generated on every build and output to the TargetDir, however it’s a good idea to include them in your Project.

In the Post-build event you can add a simple XCOPY like below to copy the files to the root of your project:

XCOPY "$(TargetDir)MyModel.csdl" "$(ProjectDir)" /R /Y
XCOPY "$(TargetDir)MyModel.ssdl" "$(ProjectDir)" /R /Y
XCOPY "$(TargetDir)MyModel.msl" "$(ProjectDir)" /R /Y

 

Step 4

Build the project which contains your Entity Model.

If it built successfully you should find the following files in the root of your Project folder

  • MyModel.Views.cs
  • MyModel.csdl
  • MyModel.ssdl
  • MyModel.msl

Go ahead and include all these files in your project, Show All Files > Right Click > Include In Project

Step 5

Now for MyModel.csl, MyModel.ssdl, MyModel.msl you want to include these as an embedded resource

For each of the above files select the “Embedded Resource” Build Action in the Properties window.

Step 6

Now it’s time to update your Entity Connection String to use the embedded resources.

Personally I prefer to use fully qualified names for the embedded resources.

e.g. 

res://*/MyNamespace.MyModel.MyModel.csdl 
You should end up with a Connection String looking like below. 
<connectionStrings>
    <add name="MyModel_Entities" connectionString="metadata=res://*/MyNamespace.MyModel.MyModel.csdl|res://*/MyNamespace.MyModel.MyModel.ssdl|res://*/MyNamespace.MyModel.MyModel.msl;provider=System.Data.SqlClient;provider connection string=&quot;Data Source=local;Initial Catalog=MyModelDatabase;Integrated Security=True;MultipleActiveResultSets=True&quot;" providerName="System.Data.EntityClient" />
  </connectionStrings>

If the path to the embedded resource is wrong you can expect to get a System.Data.MetadataException

Unable to load the specified metadata resource.

To be sure what the Resource path is, you can always use the trusty Reflector.

Finished

Enjoy your new found Entity Framework performance.
If you have any problems, don’t hesitate to let me know.

Labels:

Popular posts from this blog

Freeing Disk Space on C:\ Windows Server 2008

By Will Beattie
  I just spent the last little while trying to clear space on our servers in order to install .NET 4.5 . Decided to post so my future self can find the information when I next have to do this. I performed all the usual tasks: Deleting any files/folders from C:\windows\temp and C:\Users\%UserName%\AppData\Local\Temp Delete all EventViewer logs Save to another Disk if you want to keep them Remove any unused programs, e.g. Firefox Remove anything in C:\inetpub\logs Remove any file/folders C:\Windows\System32\LogFiles Remove any file/folders from C:\Users\%UserName%\Downloads Remove any file/folders able to be removed from C:\Users\%UserName%\Desktop Remove any file/folders able to be removed from C:\Users\%UserName%\My Documents Stop Windows Update service and remove all files/folders from C:\Windows\SoftwareDistribution Deleting an Event Logs Run COMPCLN.exe Move the Virtual Memory file to another disk However this wasn’t enough & I found the most space was
Read more

3 Reasons Why Progressive Web Apps (PWAs) Won’t Replace Native Apps

By Will Beattie
Many people believe Progressive Web Apps (PWAs) are the future of the mobile web, but in my opinion, PWAs are not a replacement for native mobile apps. Here are three reasons why: 1. Native mobile apps provide a smoother & faster experience  Mobile websites, progressive or otherwise are slower and not as smooth. 90% of the time spent is spent using apps vs the browser . The single most significant contributing factor to a smooth experience on mobile is the speed of the network and latency of the data downloaded and uploaded. When you visit websites on desktop or mobile, there is a lot of third-party code/data that gets downloaded to your device, which more often than not has zero impact on the user experience. This includes: CSS (Cascading Style Sheets) JavaScript Ad network code Facebook tracking code Google tracking code The median number of requests a mobile website makes is a shocking  69 . On the other hand, native apps only get the data that is requi
Read more

Consuming the SSRS ReportExecutionService from a .NET Client

By
  I’ve just finished writing a nice wrapper which internally calls the SSRS ReportExecutionService to generate reports. Whilst it was fairly simple to implement there has been some major changes between 2005 and 2008 and the majority of online and documentation is based on the 2005 implementation. The most important change is that the Report Server and Report Manager are no longer hosted in IIS which will be a welcomed change to Sys Admins but makes the security model and hosting model vastly different. So far I’ve yet to figure out how to allow Anonymous Access, if anyone knows how to do this leave a comment and it will be most appreciated. Getting Started To get started you’ll want to add a service reference to http://localhost/ReportServer_SQL2008/ReportExecution2005.asmx where ReportServer_SQL2008 is the name you configure in the Reporting Services Configuration Manager. The Web Application files are located in C:\Program Files\Microsoft SQL Server\MSRS10.SQL2008\R
Read more