Entity-framework – How to use Entity Framework to map results of a stored procedure to entity with differently named parameters


I am trying to create a basic example using Entity Framework to do the mapping of the output of a SQL Server Stored procedure to an entity in C#, but the entity has differently (friendly) names parameters as opposed to the more cryptic names. I am also trying to do this with the Fluent (i.e. non edmx) syntax.

What works ….

The stored procedure returns values called: UT_ID, UT_LONG_NM, UT_STR_AD, UT_CITY_AD, UT_ST_AD, UT_ZIP_CD_AD, UT_CT

If I create an object like this …

public class DBUnitEntity
    public Int16 UT_ID { get; set; }
    public string UT_LONG_NM { get; set; }
    public string UT_STR_AD { get; set; }
    public string UT_CITY_AD { get; set; }
    public string UT_ST_AD { get; set; }
    public Int32 UT_ZIP_CD_AD { get; set; }
    public string UT_CT { get; set; } 

and an EntityTypeConfiguration like this …

public class DbUnitMapping: EntityTypeConfiguration<DBUnitEntity>
        public DbUnitMapping()
            HasKey(t => t.UT_ID);

… which I add in the OnModelCreating of the DbContext, then I can get the entities just fine out of the database, which is nice, using this ….

var allUnits = _context.Database.SqlQuery<DBUnitEntity>(StoredProcedureHelper.GetAllUnitsProc);

BUT, What Doesn't Work

If I want an entity like this, with friendlier names ….

public class UnitEntity : IUnit
    public Int16 UnitId { get; set; }
    public string Name { get; set; }
    public string Address { get; set; }
    public string City { get; set; }
    public string State { get; set; }
    public Int32 Zip { get; set; }
    public string Category { get; set; }

and an EntityTypeConfiguration like this …

    public UnitMapping()
        HasKey(t => t.UnitId);

        Property(t => t.UnitId).HasColumnName("UT_ID");
        Property(t => t.Name).HasColumnName("UT_LONG_NM");
        Property(t => t.Address).HasColumnName("UT_STR_AD");
        Property(t => t.City).HasColumnName("UT_CITY_AD");
        Property(t => t.State).HasColumnName("UT_ST_AD");
        Property(t => t.Zip).HasColumnName("UT_ZIP_CD_AD");
        Property(t => t.Category).HasColumnName("UT_CT");

When I try to get the data I get a System.Data.EntityCommandExecutionException with the message ….

"The data reader is incompatible with the specified 'DataAccess.EFCodeFirstSample.UnitEntity'. A member of the type, 'UnitId', does not have a corresponding column in the data reader with the same name."

If I add the "stored procedure named" property to the entity, it goes and complains about the next "unknown" property.

Does "HasColumnName" not work as I expect/want it to in this code-first stored procedure fluent style of EF?


Tried using DataAnnotations (Key from ComponentModel, and Column from EntityFramework) … ala

public class UnitEntity : IUnit
    public Int16 UnitId { get; set; }
    public string Name { get; set; }

That did remove the need for any EntityTypeConfiguration at all for the DBUnitEntity with the database-identical naming (i.e. just adding the [Key] Attribute), but did nothing for the entity with the property names that don't match the database (same error as before).

I don't mind using the ComponentModel Annotations in the Model, but I really don't want to use the EntityFramework Annotations in the model if I can help it (don't want to tie the Model to any specific data access framework)

Best Solution

From Entity Framework Code First book (page 155):

The SQLQuery method always attempts the column-to-property matching based on property name... None that the column-to-property name matching does not take any mapping into account. For example, if you had mapped the DestinationId property to a column called Id in the Destination table, the SqlQuery method would not use this mapping.

So you cannot use mappings when calling stored procedure. One workaround is to modify your stored procedure to return result with aliases for each column that will match your object properties' names.

Select UT_STR_AD as Address From SomeTable etc