{"id":804,"date":"2014-01-14T14:25:29","date_gmt":"2014-01-14T14:25:29","guid":{"rendered":"https:\/\/blogs.msdn.microsoft.com\/webdev\/2014\/01\/14\/scaffolding-ado-net-entity-data-model-designer-based-models\/"},"modified":"2022-08-09T02:52:49","modified_gmt":"2022-08-09T09:52:49","slug":"scaffolding-ado-net-entity-data-model-designer-based-models","status":"publish","type":"post","link":"https:\/\/devblogs.microsoft.com\/dotnet\/scaffolding-ado-net-entity-data-model-designer-based-models\/","title":{"rendered":"Scaffolding ADO.NET Entity Data Model Designer-based-models"},"content":{"rendered":"

The ADO.NET Entity Data Model Designer (Entity Designer) is a GUI tool for editing Entity Framework models. You can use the Entity Designer to visually create and modify entities, associations, mappings, and inheritance relationships. You can also use the tool to validate the model. <\/p>\n

When you build the Entity Framework models, Entity Designer in Visual Studio 2013 generates a DbContext<\/b> based container with the associated T4 template. These context files do not carry any metadata information for the target EDMX files. They are generated to always throw the UnintentionalCodeFirstException<\/b> as follows:<\/p>\n

\n
\n
Code Snippet<\/div>\n
\n
    \n
  1. <\/span>protected<\/span> <\/span>override<\/span> <\/span>void<\/span> OnModelCreating(DbModelBuilder modelBuilder)<\/span><\/li>\n
  2. {<\/span><\/li>\n
  3. \u00a0\u00a0\u00a0\u00a0<\/span>throw<\/span> <\/span>new<\/span> UnintentionalCodeFirstException();<\/span><\/li>\n
  4. }<\/span><\/li>\n<\/ol><\/div>\n<\/p><\/div>\n<\/p><\/div>\n

    Note:
    See http:\/\/blog.oneunicorn.com\/2012\/02\/26\/dont-use-code-first-by-mistake\/<\/a>, for more information about UnintentionalCodeFirstException<\/b>.<\/p>\n

    Instead, the metadata information that you described in Entity Designer is embedded into the target assemblies as resources when the Metadata Artifact Processing<\/b> property of the EDMX file is set to Embed in Output Assembly<\/b>, which is default. If the property is set to Copy to Output Directory<\/b>, it is copied to separate files. For both cases, Entity Designer adds an EntityConnection <\/b>connection string into the Web.config file of the target Web project as follows:<\/p>\n

    \n
    \n
    Code Snippet<\/div>\n
    \n
      \n
    1. <<\/span>configuration<\/span>><\/span><\/li>\n
    2. \u00a0\u00a0<<\/span>connectionStrings<\/span>><\/span><\/li>\n
    3. \u00a0\u00a0\u00a0\u00a0<<\/span>add<\/span> <\/span>name<\/span>=<\/span>"<\/span>Northwind_Entities<\/span>"<\/span><\/li>\n
    4. \u00a0\u00a0\u00a0\u00a0<\/span>connectionString<\/span>=<\/span>"<\/span>metadata=res:\/\/*\/Northwind.csdl|<\/span><\/li>\n
    5. \u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0res:\/\/*\/Northwind.ssdl|<\/span><\/li>\n
    6. \u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0res:\/\/*\/Northwind.msl;<\/span><\/li>\n
    7. \u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0provider=System.Data.SqlClient;<\/span><\/li>\n
    8. \u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0provider connection string=<\/span>&quot;<\/span>Data Source=.\sqlexpress;nitial Catalog=Northwind;Integrated Security=True;MultipleActiveResultSets=True<\/span>&quot;<\/span>"<\/span><\/li>\n
    9. \u00a0\u00a0\u00a0\u00a0<\/span>providerName<\/span>=<\/span>"<\/span>System.Data.EntityClient<\/span>"<\/span>\/><\/span><\/li>\n
    10. \u00a0\u00a0<\/<\/span>connectionStrings<\/span>><\/span><\/li>\n
    11. <\/<\/span>configuration<\/span>><\/span><\/li>\n<\/ol><\/div>\n<\/p><\/div>\n<\/p><\/div>\n

      Entity Designer also creates a DbContext<\/b> constructor to have DbContext<\/b> use the connection string to retrieve the metadata information by passing the connection string name. For example:<\/p>\n

      \n
      \n
      Code Snippet<\/div>\n
      \n
        \n
      1. public<\/span> <\/span>class<\/span> <\/span>NorthwindContext<\/span> : DbContext<\/span><\/li>\n
      2. {<\/span><\/li>\n
      3. \u00a0\u00a0\u00a0\u00a0<\/span>public<\/span> NorthwindContext()<\/span><\/li>\n
      4. \u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0: <\/span>base<\/span>(<\/span>"name=Northwind_Entities"<\/span>)<\/span><\/li>\n
      5. \u00a0\u00a0\u00a0\u00a0{<\/span><\/li>\n
      6. \u00a0\u00a0\u00a0\u00a0}<\/span><\/li>\n
      7. }<\/span><\/li>\n<\/ol><\/div>\n<\/p><\/div>\n<\/p><\/div>\n

        Note: to see more information about how Entity Framework uses connection strings, see http:\/\/msdn.microsoft.com\/en-US\/data\/jj592674<\/a>.<\/p>\n

        To scaffold the models with the connection strings, you have to choose the generated container for the data context classes. In this walkthrough, you will scaffold the EDMX generated models for Model First approach. You should be able to use the same tool for Database First approach in a similar way. <\/p>\n

        1. Open an existing MVC 5 project in Visual Studio 2013 or create a new MVC 5 project. In this walkthrough, we will use the MVC project template with the default options. <\/p>\n

        2. Create a sample model with Entity Designer<\/p>\n

        \n

        a. In Solution Explorer, under the Models<\/b> folder, add a new ADO.NET Entity Data Model <\/b>item called BloggingModel<\/b>. <\/p>\n

        \"image\"<\/a> <\/p>\n<\/blockquote>\n

        \n

        b. In the following Entity Data Model Wizard, select Empty model<\/b>, and then click Finish<\/b>.<\/p>\n

        \"image\"<\/a> <\/p>\n<\/p>\n<\/blockquote>\n

        3. The Entity Designer is opened with a blank model. Now we can start adding entities, properties and associations to the model.<\/p>\n

        \n

        a. Right-click on the design surface and select Properties.<\/b><\/p>\n<\/blockquote>\n

        \n

        b. In the Properties<\/b> window change the Entity Container Name<\/b> to BloggingContext.<\/b>
        This is the name of the derived context that will be generated for you, the context represents a session with the database, allowing us to query and save data.<\/p>\n<\/blockquote>\n

        \n

        c. Right-click on the design surface and select Add New -> Entity<\/b>. <\/p>\n<\/blockquote>\n

        \n

        d. Enter Blog<\/b> as the entity name and BlogId<\/b> as the key name and click OK.<\/b><\/p>\n

        \"image\"<\/a> <\/p>\n<\/blockquote>\n

        \n

        e. Right-click on the new entity on the design surface and select Add New -> Scalar Property<\/b>, enter Name<\/b> as the name of the property.<\/p>\n

        f. Repeat this process to add a Url<\/b> property.<\/p>\n

        g. Right-click on the Url<\/b> property on the design surface and select Properties<\/b>, in the Properties<\/b> window change the Nullable<\/b> setting to True
        This allows us to save a Blog to the database without assigning it a Url.<\/b><\/p>\n

        h. Using the same steps used to create the Blog<\/b> entity, add a Post<\/b> entity with a PostId<\/b> key property.<\/p>\n

        i. Add Title<\/b> and Content<\/b> scalar properties to the Post entity.<\/p>\n<\/blockquote>\n

        4. Now that we have a couple of entities, add an association (or relationship) between them.<\/p>\n

        \n

        a. Right-click on the design surface and select Add New -> Association<\/b>.<\/p>\n

        b. Make one end of the relationship point to Blog<\/b> with a multiplicity of One<\/b> and the other end point to Post<\/b> with a multiplicity of Many.<\/b>
        This means that a Blog has many Posts and a Post belongs to one Blog.<\/p>\n

        c. Ensure the Add foreign key properties to ‘Post’ Entity<\/b> box is checked and click OK<\/b>.<\/p>\n

        \"image\"<\/a> <\/p>\n<\/blockquote>\n

        5. Given our model, Entity Framework can calculate a database schema that will allow us to store and retrieve data using the model. To do that, we should map the model to the physical database. For Model First Approach, we will generate a database from the model. <\/p>\n

        Note:
        You do not need to perform this step in Database First Approach because your models are already mapped to the database. For more information about how to use Entity Designer for Database First approach, see         http:\/\/msdn.microsoft.com\/en-us\/data\/jj206878.aspx<\/a>.<\/p>\n

        \n

        a. Right-click on the design surface and select Generate Database from Model<\/b>. <\/p>\n

        b. Click New Connection<\/b>, select Microsoft SQL Server<\/b> for Data source<\/b>, specify (localdb)v11.0<\/b>, and then enter ModelFirst.Blogging<\/b> as the database name.<\/p>\n

        \"image\"<\/a> <\/p>\n

        c. Select OK<\/b> and you will be asked if you want to create a new database, select Yes. <\/b>Make sure that the Save entity connection settings in Web.Config<\/b> check box is selected.<\/p>\n

        d. Select Next<\/b> and the Entity Framework Designer will calculate a script to create the database schema.<\/p>\n

        e. Once the script is displayed, click Finish<\/b> and the script will be added to your project and opened<\/p>\n

        f. Right-click on the script and select Execute<\/b>, you will be prompted to specify the database to connect to, specify (localdb)v11.0<\/b>.<\/p>\n<\/blockquote>\n

        6. Build the project. The Entity Designer generates two entity classes, Blog and Post, and the database context file as follows:<\/p>\n

        \"image\"<\/a> <\/p>\n

        \n

        a. Open the Web.config<\/i> file to verify the connection string that Entity Designer adds. The name of the generated connection string should have the same name that you set for the Entity Container Name<\/b> property. In this walkthrough, it is BloggingContext<\/b>. <\/p>\n

        \n
        \n
        Code Snippet<\/div>\n
        \n
          \n
        1. <<\/span>add<\/span> <\/span>name<\/span>=<\/span>"<\/span>BloggingContext<\/span>"<\/span> <\/span><\/li>\n
        2. \u00a0\u00a0\u00a0\u00a0\u00a0<\/span>connectionString<\/span>=<\/span>"<\/span>metadata=res:\/\/*\/BloggingModel.csdl|res:\/\/*\/BloggingModel.ssdl|res:\/\/*\/BloggingModel.msl;provider=System.Data.SqlClient;provider connection string=<\/span>&quot;<\/span>data source=(localdb)\v11.0;initial catalog=ModelFirst.Blogging;integrated security=True;MultipleActiveResultSets=True;App=EntityFramework<\/span>&quot;<\/span>"<\/span> <\/span><\/li>\n
        3. providerName<\/span>=<\/span>"<\/span>System.Data.EntityClient<\/span>"<\/span> \/><\/span><\/li>\n<\/ol><\/div>\n<\/p><\/div>\n<\/p><\/div>\n<\/blockquote>\n
          \n

          b. Open BloggingModel.Context.cs<\/b> to verify the constructor generated to use the connection string. <\/p>\n

          \n
          \n
          Code Snippet<\/div>\n
          \n
            \n
          1. public<\/span> <\/span>partial<\/span> <\/span>class<\/span> <\/span>BloggingContext<\/span> : DbContext<\/span><\/li>\n
          2. {<\/span><\/li>\n
          3. \u00a0\u00a0\u00a0\u00a0<\/span>public<\/span> BloggingContext()<\/span><\/li>\n
          4. \u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0: <\/span>base<\/span>(<\/span>"name=BloggingContext"<\/span>)<\/span><\/li>\n
          5. \u00a0\u00a0\u00a0\u00a0{<\/span><\/li>\n
          6. \u00a0\u00a0\u00a0\u00a0}<\/span><\/li>\n
          7.  <\/li>\n
          8. \u00a0\u00a0\u00a0\u00a0<\/span>protected<\/span> <\/span>override<\/span> <\/span>void<\/span> OnModelCreating(DbModelBuilder modelBuilder)<\/span><\/li>\n
          9. \u00a0\u00a0\u00a0\u00a0{<\/span><\/li>\n
          10. \u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<\/span>throw<\/span> <\/span>new<\/span> UnintentionalCodeFirstException();<\/span><\/li>\n
          11. \u00a0\u00a0\u00a0\u00a0}<\/span><\/li>\n
          12.  <\/li>\n
          13. \u00a0\u00a0\u00a0\u00a0<\/span>public<\/span> <\/span>virtual<\/span> DbSet<Blog> Blogs { <\/span>get<\/span>; <\/span>set<\/span>; }<\/span><\/li>\n
          14. \u00a0\u00a0\u00a0\u00a0<\/span>public<\/span> <\/span>virtual<\/span> DbSet<Post> Posts { <\/span>get<\/span>; <\/span>set<\/span>; }<\/span><\/li>\n
          15. }<\/span><\/li>\n<\/ol><\/div>\n<\/p><\/div>\n<\/p><\/div>\n<\/blockquote>\n

            7. Build your project again to make sure everything works fine. You can now use new ASP.NET Scaffolding as usual for the EDMX generated models, Blog and Post. Just do not forget to select the newly generated BloggingContext<\/b> for Data context class<\/b> while scaffolding as follows: <\/p>\n

            \"image\"<\/a> <\/p>\n

            Note:
            For more information on how to use new MVC5 ASP.NET Scaffolding, see             http:\/\/www.asp.net\/visual-studio\/overview\/2013\/aspnet-scaffolding-overview<\/a>. <\/p>\n","protected":false},"excerpt":{"rendered":"

            The ADO.NET Entity Data Model Designer (Entity Designer) is a GUI tool for editing Entity Framework models. You can use the Entity Designer to visually create and modify entities, associations, mappings, and inheritance relationships. You can also use the tool to validate the model. When you build the Entity Framework models, Entity Designer in Visual […]<\/p>\n","protected":false},"author":428,"featured_media":58792,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"_acf_changed":false,"footnotes":""},"categories":[197],"tags":[7333,34,7436,7374,7389],"class_list":["post-804","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-aspnet","tag-asp-net-mvc","tag-asp-net-web-api","tag-visual-studio-2013","tag-web-deployment-tool","tag-web-development"],"acf":[],"blog_post_summary":"

            The ADO.NET Entity Data Model Designer (Entity Designer) is a GUI tool for editing Entity Framework models. You can use the Entity Designer to visually create and modify entities, associations, mappings, and inheritance relationships. You can also use the tool to validate the model. When you build the Entity Framework models, Entity Designer in Visual […]<\/p>\n","_links":{"self":[{"href":"https:\/\/devblogs.microsoft.com\/dotnet\/wp-json\/wp\/v2\/posts\/804","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/devblogs.microsoft.com\/dotnet\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/devblogs.microsoft.com\/dotnet\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/dotnet\/wp-json\/wp\/v2\/users\/428"}],"replies":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/dotnet\/wp-json\/wp\/v2\/comments?post=804"}],"version-history":[{"count":0,"href":"https:\/\/devblogs.microsoft.com\/dotnet\/wp-json\/wp\/v2\/posts\/804\/revisions"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/dotnet\/wp-json\/wp\/v2\/media\/58792"}],"wp:attachment":[{"href":"https:\/\/devblogs.microsoft.com\/dotnet\/wp-json\/wp\/v2\/media?parent=804"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/dotnet\/wp-json\/wp\/v2\/categories?post=804"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/dotnet\/wp-json\/wp\/v2\/tags?post=804"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}