Ignore properties in data model while keeping them in EF Core migrations

Question

I am creating a greenfield application that uses EF Core which must talk to a legacy database. I want EF to ignore some of the columns in the database because they will eventually be deprecated and I don't want them in the new entity model. I can't remove them yet as the legacy system still relies on them.

For an unwanted database column called DeprecatedFeature, I want to do something like:

modelBuilder.Entity<MyEntity>(entity => {
   entity.HasKey(t => t.Id);
   entity.ToTable("MyEntity");
   entity.ColumnIgnore("DeprecatedFeature"); // <-- this is what I want to do
})

Right now, the best I can do is include the property and mark it as obsolete:

public class MyEntity 
{
    public int Id { get; set; }

    [Obsolete("Deprecated in latest version")]
    public string DeprecatedFeature { get; set; }
}

But that means I can't turn on "warnings as errors". I still need to run migrations on my database.

Similar questions: EF 4.x, EF Core skip column on load, Using EF Designer/EDMX and duplicate

Edit

I can see by the answers that there is some confusion about my question:

NotMapped is NOT the answer

NotMapped is used when you have a property in your model that you don't want in the database. My problem is the other way around. I have a column in my database that I don't want in my model.

Answer 1

You have two alternatives:

1. Using NotMappedAttribute:

   public class MyEntity
   {
        public int Id { get; set; }    
        [NotMapped]
        public string DeprecatedFeature { get; set; }
   }
   

2. Using FluentAPI:

   modelBuilder.Entity<MyEntity>().Ignore(c => c.DeprecatedFeature);
   

Answer 2

Just don't include that property in your entity class. EntityFramework should just ignore it then.

public class MyEntity 
{
    public int Id { get; set; }

    // Remove this property
    //public string DeprecatedFeature { get; set; }
}

You should be able to access this entity from the database without any problems, and your application code won't have access to the deprecated property. If you need write to this table, the deprecated column will need to either be nullable or have a default value.

---

Edit:

You can create a shadow property like this:

entity.Property(typeof(string), "DeprecatedFeature");

This will let EF be aware of the property (and include it in migrations), but the property doesn't need to exist on the entity type.

Answer 3

I didn't see an accepted answer to this question so here is mine. I believe that the thing called "shadow properties" is exactly what you need.

With a shadow property you can define a field in the table but don't add a property to your model class:

protected override void OnModelCreating(ModelBuilder modelBuilder)
{
    modelBuilder.Entity<MyEntity>()
        .Property<string>("DeprecatedFeature");
}

Answer 4

I have similar requirement, where I need the property in code but db populates the field. I used the following attribute under System.ComponentModel.DataAnnotations.Schema namespace

[DatabaseGenerated(DatabaseGeneratedOption.Computed)]

This way, the property is mapped but is not populated when using entityframework.