How do I remove underscore of foreign key fields in code first by convention

by

I finally found an answer for this, by writing a custom convention. This convention works in EF 6.0 RC1 (code from last week), so I think it’s likely to continue to work after EF 6.0 is released.

With this approach, the standard EF conventions identify the independent associations (IAs), and then create the EdmProperty for the foreign key field. Then this convention comes along and renames the foreign key fields.

/// <summary>
/// Provides a convention for fixing the independent association (IA) foreign key column names.
/// </summary>
public class ForeignKeyNamingConvention : IStoreModelConvention<AssociationType>
{

    public void Apply(AssociationType association, DbModel model)
    {
        // Identify a ForeignKey properties (including IAs)
        if (association.IsForeignKey)
        {
            // rename FK columns
            var constraint = association.Constraint;
            if (DoPropertiesHaveDefaultNames(constraint.FromProperties, constraint.ToRole.Name, constraint.ToProperties))
            {
                NormalizeForeignKeyProperties(constraint.FromProperties);
            }
            if (DoPropertiesHaveDefaultNames(constraint.ToProperties, constraint.FromRole.Name, constraint.FromProperties))
            {
                NormalizeForeignKeyProperties(constraint.ToProperties);
            }
        }
    }

    private bool DoPropertiesHaveDefaultNames(ReadOnlyMetadataCollection<EdmProperty> properties, string roleName, ReadOnlyMetadataCollection<EdmProperty> otherEndProperties)
    {
        if (properties.Count != otherEndProperties.Count)
        {
            return false;
        }

        for (int i = 0; i < properties.Count; ++i)
        {
            if (!properties[i].Name.EndsWith("_" + otherEndProperties[i].Name))
            {
                return false;
            }
        }
        return true;
    }

    private void NormalizeForeignKeyProperties(ReadOnlyMetadataCollection<EdmProperty> properties)
    {
        for (int i = 0; i < properties.Count; ++i)
        {
            string defaultPropertyName = properties[i].Name;
            int ichUnderscore = defaultPropertyName.IndexOf('_');
            if (ichUnderscore <= 0)
            {
                continue;
            }
            string navigationPropertyName = defaultPropertyName.Substring(0, ichUnderscore);
            string targetKey = defaultPropertyName.Substring(ichUnderscore + 1);

            string newPropertyName;
            if (targetKey.StartsWith(navigationPropertyName))
            {
                newPropertyName = targetKey;
            }
            else
            {
                newPropertyName = navigationPropertyName + targetKey;
            }
            properties[i].Name = newPropertyName;
        }
    }

}

Note that the Convention is added to your DbContext in your DbContext.OnModelCreating override, using:

modelBuilder.Conventions.Add(new ForeignKeyNamingConvention());

More Related Contents:

  1. Unique Constraint in Entity Framework Code First
  2. Entity Framework Code First – No Detach() method on DbContext
  3. How to configure ProviderManifestToken for EF Code First
  4. Entity Framework loading child collection with sort order
  5. How can I delete 1,000 rows with EF6?
  6. Entity Framework CTP 4 – Code First Custom Database Initializer
  7. Multi-async in Entity Framework 6?
  8. How to create index in Entity Framework 6.2 with code first
  9. How can I disable code first migrations
  10. Upgrade EF 4 EDMX to EF 6
  11. SQL Server Express connection string for Entity Framework Code First
  12. How to create index in Entity Framework 6.2 with fluent configuration
  13. How do I use Entity Framework in Code First Drop-Create mode?
  14. Nullable property to entity field, Entity Framework through Code First
  15. Change foreign key constraint naming convention
  16. Entity Framework Code First Many to Many Setup For Existing Tables
  17. Entity Framework – Why explicitly set entity state to modified?
  18. Convert value when mapping
  19. Dynamic MySQL database connection for Entity Framework 6
  20. Entity framework code-first null foreign key
  21. How do you ensure Cascade Delete is enabled on a table relationship in EF Code first?
  22. ef core 2 apply HasQueryFilter for all entity
  23. Value cannot be null. Parameter name: entitySet
  24. Entity Framework 6 transaction rollback
  25. Entity Framework Code First – Advantages and disadvantages of Fluent Api vs Data Annotations [closed]
  26. How can I disable migration in Entity Framework 6.0
  27. Async PartialView causes “HttpServerUtility.Execute blocked…” exception
  28. Many to Many Relationships not saving
  29. How to group by DateTime.Date in EntityFramework
  30. EF Core 2: How to apply HasQueryFilter for all entities

Leave a Comment