Skip to main content

Data seed for the application with EF, MongoDB or any other ORM.

Most of ORMs has moved to Code first approach where everything is derived/initialized from codes rather than DB side. In this situation, it is better to set data through codes only. We would be looking through simple technique where we would be Seeding data through Codes.

I would be using UnitOfWork and Repository pattern for implementing Data Seeding technique. This can be applied to any data source MongoDB, EF, or any other ORM or DB.

Things we would be doing.
- Creating a base class for easy usage.
- Interface for Seed function for any future enhancements.
- Individual seed classes.
- Configuration to call all seeds.
- AspNet core configuration to Seed data through Seed configuration.

Creating a base class for easy usage

  
 public abstract class BaseSeed<TModel>  
      where TModel : class  
 {  
      protected readonly IMyProjectUnitOfWork MyProjectUnitOfWork;  
 
      public BaseSeed(IMyProjectUnitOfWork MyProjectUnitOfWork)  
      {  
           MyProjectUnitOfWork = MyProjectUnitOfWork;  
      }  
     
      protected void Save(TModel model, IRepository<TModel> repository)  
      {  
           repository.Create(model);  
           MyProjectUnitOfWork.Save();  
      }  
 }

This would be just helpful for individual data seeds.

Interface for Seed function for any future enhancements


  
 public interface ISeed  
 {  
  
   void Seed();  
 }


Individual seed classes


  
 public class LookupSeeder  
      : BaseSeed<Lookup>, ISeed  
 {  
     
      public LookupSeeder(IMyProjectUnitOfWork MyProjectUnitOfWork)  
           : base(MyProjectUnitOfWork)  
      {  
      }  
     
      public void Seed()  
      {  
           InsertState();  
           InsertLanguage();  
      }    
     
   private readonly Lazy<List<Lookup>> States = new Lazy<List<Lookup>>(() => new List<Lookup>  
     {  
       new Lookup {  
         LookupType = LookupType.State,  
         LookupValue= "ALABAMA",  
         LookupIdString= "AL"  
       },  
       new Lookup {  
         LookupType = LookupType.State,  
         LookupValue= "MyProject",  
         LookupIdString= "AK"  
       },  
       new Lookup {  
         LookupType = LookupType.State,  
         LookupValue= "MINNESOTA",  
         LookupIdString= "MN"  
       },  
       new Lookup {  
         LookupType = LookupType.State,  
         LookupValue= "MISSISSIPPI",  
         LookupIdString= "MS"  
       },  
       new Lookup {  
         LookupType = LookupType.State,  
         LookupValue= "NEVADA",  
         LookupIdString= "NV"  
       },  
       new Lookup {  
         LookupType = LookupType.State,  
         LookupValue= "NEW HAMPSHIRE",  
         LookupIdString= "NH"  
       },  
     }  
     );  
   /// <summary>  
   /// Initial inserts for <see cref="LookupType.State"/>  
   /// </summary>  
   private void InsertState()  
   {  
     var lookupRepo = MyProjectUnitOfWork.LookupRepository;  
     if (!lookupRepo.Any(lookup => lookup.LookupType == LookupType.State))  
     {  
       lookupRepo.Create(States.Value);  
       MyProjectUnitOfWork.Save();  
     }  
   }  
   #endregion " Initial records for State"  
   /// <summary>  
   /// Inserts the <see cref="LookupType.Language"/> lookups.  
   /// </summary>  
   private void InsertLanguage()  
   {  
     var lookupRepo = MyProjectUnitOfWork.LookupRepository;  
     if (!lookupRepo.Any(lookup => lookup.LookupType == LookupType.Language))  
     {  
       lookupRepo.Create(new List<Lookup> {  
         new Lookup {  
           LookupType = LookupType.Language,  
           LookupIdString = "ENGLISH",  
           LookupValue = "ENGLISH"  
         },  
         new Lookup {  
           LookupType = LookupType.Language,  
           LookupIdString = "SPANISH",  
           LookupValue = "SPANISH"  
         },  
       });  
       MyProjectUnitOfWork.Save();  
     }  
   }   
 }

If you see, these are pretty simple queries statements. There are two major things, checking if any data exists and then inserting based on condition. In a similar pattern, we can have multiple conditions and insert statements with multiple classes based on Domain/Data models.

Configuration to call all seeds

This is just a simple class that would call all individual Seeder classes based on domain models.

 /// <summary>  
 /// Database seeding configuration.  
 /// </summary>  
 public static class DataSeederConfig  
 {  
      /// <summary>  
      /// Seeds the database.  
      /// </summary>  
      /// <param name="serviceCollection">The service collection.</param>  
      public static void SeedDatabase(this IServiceProvider serviceCollection)  
      {  
           var uow = serviceCollection.GetService<IMyProjectUnitOfWork>();  
           Seed(uow);  
      }  
      /// <summary>  
      /// Seeds the specified MyProject unit of work.  
      /// </summary>  
      /// <param name="myProjectUnitOfWork">The MyProject unit of work.</param>  
      private static void Seed(IMyProjectUnitOfWork myProjectUnitOfWork)  
      {  
           // Order is important as id generation are dependent on each other.  
           // Parent to child item is followed.  
           new LookupSeederSql(myProjectUnitOfWork).Seed();  
           myProjectUnitOfWork.Save();  
      }  
 }

AspNet core configuration to Seed data through Seed configuration

Now, we are all set for the final piece. There is only one endpoint to configure entire Data seeds through DataSeederConfig class having extension method SeedDatabase.

This has to be configured on Startup.cs

 public void Configure(IApplicationBuilder app, IHostingEnvironment env, ILoggerFactory loggerFactory)  
 {  
      if (env.IsDevelopment())  
      {  
           using (var serviceScope = app.ApplicationServices.GetRequiredService<IServiceScopeFactory>()  
                          .CreateScope())  
           {  
                serviceScope.ServiceProvider.GetService<MyProjectContext>()  
                      .Database.Migrate();  
                serviceScope.ServiceProvider.SeedDatabase();  
           }  
           app.UseBrowserLink();  
           app.UseDeveloperExceptionPage();  
      }  
 }

The above code would do DB migration and seeding of data in DB.


Labels

Labels:

Comments

Post a Comment

Popular posts from this blog

Elegantly dealing with TimeZones in MVC Core / WebApi

In any new application handling TimeZone/DateTime is mostly least priority and generally, if someone is concerned then it would be handled by using DateTime.UtcNow on codes while creating current dates and converting incoming Date to UTC to save on servers. Basically, the process is followed by saving DateTime to UTC format in a database and keep converting data to native format based on user region or single region in the application's presentation layer. The above is tedious work and have to be followed religiously. If any developer misses out the manual conversion, then that area of code/view would not work. With newer frameworks, there are flexible ways to deal/intercept incoming or outgoing calls to simplify conversion of TimeZones. These are steps/process to achieve it. 1. Central code for storing user's state about TimeZone. Also, central code for conversion logic based on TimeZones. 2. Dependency injection for the above class to ...
4 comments
Read more

Making FluentValidation compatible with Swagger including Enum or fixed List support

FluentValidation is not directly compatible with Swagger API to validate models. But they do provide an interface through which we can compose Swagger validation manually. That means we look under FluentValidation validators and compose Swagger validator properties to make it compatible. More of all mapping by reading information from FluentValidation and setting it to Swagger Model Schema. These can be done on any custom validation from FluentValidation too just that proper schema property has to be available from Swagger. Custom validation from Enum/List values on FluentValidation using FluentValidation.Validators; using System.Collections.Generic; using System.Linq; using static System.String; /// <summary> /// Validator as per list of items. /// </summary> /// <seealso cref="PropertyValidator" /> public class FixedListValidator : PropertyValidator { /// <summary> /// Gets the valid items /// <...
1 comment
Read more

Handling JSON DateTime format on Asp.Net Core

This is a very simple trick to handle JSON date format on AspNet Core by global settings. This can be applicable for the older version as well. In a newer version by default, .Net depends upon Newtonsoft to process any JSON data. Newtonsoft depends upon Newtonsoft.Json.Converters.IsoDateTimeConverter class for processing date which in turns adds timezone for JSON data format. There is a global setting available for same that can be adjusted according to requirement. So, for example, we want to set default formatting to US format, we just need this code. services.AddMvc() .AddJsonOptions(options => { options.SerializerSettings.DateTimeZoneHandling = "MM/dd/yyyy HH:mm:ss"; });
1 comment
Read more

Architecture solution composting Repository Pattern, Unit Of Work, Dependency Injection, Factory Pattern and others

Project architecture is like garden, we plant the things in certain order and eventually they grow in similar manner. If things are planted well then they will all look(work) great and easier to manage. If they grow as cumbersome it would difficult to maintain and with time more problems would be happening in maintenance. There is no any fixed or known approach to decide project architecture and specially with Agile Methodology. In Agile Methodology, we cannot predict how our end products will look like similarly we cannot say a certain architecture will fit well for entire development lifespan for project. So, the best thing is to modify the architecture as per our application growth. I understand that it sounds good but will be far more problematic with actual development. If it is left as it is then more problems will arise with time. Just think about moving plant vs a full grown tree. Coming to technical side, In this article, I will be explaining about the various techniques ...
Post a Comment
Read more

Using Redis distributed cache in dotnet core with helper extension methods

Redis cache is out process cache provider for a distributed environment. It is popular in Azure Cloud solution, but it also has a standalone application to operate upon in case of small enterprises application. How to install Redis Cache on a local machine? Redis can be used as a local cache server too on our local machines. At first install, Chocolatey https://chocolatey.org/ , to make installation of Redis easy. Also, the version under Chocolatey supports more commands and compatible with Official Cache package from Microsoft. After Chocolatey installation hit choco install redis-64 . Once the installation is done, we can start the server by running redis-server . Distributed Cache package and registration dotnet core provides IDistributedCache interface which can be overrided with our own implementation. That is one of the beauties of dotnet core, having DI implementation at heart of framework. There is already nuget package available to override IDistributedCache i...
3 comments
Read more

Kendo MVC Grid DataSourceRequest with AutoMapper

Kendo Grid does not work directly with AutoMapper but could be managed by simple trick using mapping through ToDataSourceResult. The solution works fine until different filters are applied. The problems occurs because passed filters refer to view model properties where as database model properties are required after AutoMapper is implemented. So, the plan is to intercept DataSourceRequest  and modify names based on database model. To do that we are going to create implementation of  CustomModelBinderAttribute to catch calls and have our own implementation of DataSourceRequestAttribute from Kendo MVC. I will be using same source code from Kendo but will replace column names for different criteria for sort, filters, group etc. Let's first look into how that will be implemented. public ActionResult GetRoles([MyDataSourceRequest(GridId.RolesUserGrid)] DataSourceRequest request) { if (request == null) { throw new Argume...
Post a Comment
Read more

Using LINQ to Entity efficiently with First/FirstOrDefault/Last/LastOrDefault/Single/SingleOrDefault

We generally use these extension methods First/FirstOrDefault/Last/LastOrDefault/Single/SingleOrDefault with predicates like ctx=> ctx.Model.FirstOrDefault(item => item.Id == 1 ) Or ctx=> ctx.Model.Where(item => item.Id == 1 ).FirstOrDefault() What is the problem with these? FirstOrDefault or similar methods immediately loads all data at once. So, let's say we have fifty columns on table then all those columns data would be retrieved from DB and saved into memory. This link gives a fair idea of different function behavior.  https://msdn.microsoft.com/en-us/library/bb882641.aspx .  So, even if we require only one value from selected field it retrieves all values. What is the solution? The solution is pretty simple. Whenever we need selected items better to do projection before calling FirstOrDefault or similar methods. Ex: Selecting single item ctx.Model.Where(itm => itm.Id == 1) .Select(itm => itm.Name).FirstO...
Post a Comment
Read more

Visual Studio 2015 Code Analyzer and configuration with StyleCop

What is Diagnostic/Code Analyzer? To put it simply it is something similar to Resharper or Telerik JustCode. It analyzes codes while writing on code editor and suggest for improvements of codes through Squiggles, light icon and based on various severity. How it works? I had mentioned that it is similar to Resharper and Telerik JustCode but internal infrastructure is completely different. It is dependent on new compiler Roslyn . Roslyn has a clever compile technique, unlike older version which makes it faster and flexible for dynamic compilation without the need of the entire code base. The structure is basically divided into two categories Syntax Tree , and Semantic Model . The syntax tree is related to syntaxes only it does not require any reference check. It can be related to DOM elements structure in case of HTML.  Syntax Tree consists of very fine details as simple as WhiteSpace under the code. The Semantic Model is kind of references of Syntax Tree in which it ...
Post a Comment
Read more

Kendo MVC Grid DataSourceRequest with AutoMapper - Advance

The actual process to make DataSourceRequest compatible with AutoMapper was explained in my previous post  Kendo MVC Grid DataSourceRequest with AutoMapper , where we had created custom model binder attribute and in that property names were changed as data models. In this post we will be looking into using AutoMapper's Queryable extension to retrieve the results based on selected columns. When  Mapper.Map<RoleViewModel>(data)  is called it retrieves all column values from table. The Queryable extension provides a way to retrieve only selected columns from table. In this particular case based on properties of  RoleViewModel . The previous approach that we implemented is perfect as far as this article ( 3 Tips for Using Telerik Data Access and AutoMapper ) is concern about performance where it states: While this functionality allows you avoid writing explicit projection in to your LINQ query it has the same fatal flaw as doing so - it prevents the qu...
Post a Comment
Read more