Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Entity Framework Navigation Property generation rules

I would like to know what rules Entity Framework follows in regards to the naming/generation of navigation properties. I have observed several scenarios which don't seem to make sense so I was wondering if anyone knows exactly how these work.

Scenario 1:

public class Post
{
    public int Id { get; set; }
    public User Author { get; set; }
} 

   Generates

Scenario 1

ie. by default navigation properties generate FKs named [PropertyName]_Id

Scenario 2:

It makes sense that if EF generates properties such of the format [PropertyName]_Id when you manually specify a FK Id it will follow the same rules however:

public class Post
{
    public int Id { get; set; }
    public int? Author_Id { get; set; }
    public User Author { get; set; }
}

   Generates

Scenario 2

As you can see this doesn't automatically register as a nav property.

Scenario 3:

If it doesn't work for Scenario 2 why does it work for an alternate naming convention?

public class Post
{
    public int Id { get; set; }
    public int? AuthorId { get; set; }
    public User Author { get; set; }
}

   Generates

Scenario 3

What are the rules around navigation property detection and generation?

like image 364
Not loved Avatar asked Jun 18 '12 09:06

Not loved


People also ask

What are navigation properties in Entity Framework?

A navigation property is an optional property on an entity type that allows for navigation from one end of an association to the other end. Unlike other properties, navigation properties do not carry data.

What is a navigation property EF core?

A navigation property is one that the database provider being used cannot map to a primitive (or scalar) type. The following code depicts the model representation of the database example above: public class Author. { public int AuthorId { get; set; }

What are the different types of properties supported in Entity Framework?

An Entity can include two types of properties: Scalar Properties and Navigation Properties. Scalar Property: The type of primitive property is called scalar properties. Each scalar property maps to a column in the database table which stores the real data.

How will you create relationship between tables in Entity Framework?

You can create such a relationship by defining a third table, called a junction table, whose primary key consists of the foreign keys from both table A and table B.


1 Answers

That is expected behavior and it is based on two different conventions based by EF

  • In the first example you are using Independent association where your entity doesn't have FK property. EF will create FK in the database using simple pattern: NameOfNavigationProperty_NameOfRelatedPK This convention follows traditional database naming.
  • In the second example you defined property with the same name as FK used by EF. EF detected this and added 1 to its generated FK. The reason why your property is not used as FK is the second convention which searches for FK properties. This convention expects that FK property will have this name (conventions follows traditional .NET naming):
    • NameOfNavigationPropertyNameOfRelatedPK provided by NavigationPropertyNameForeignKeyDiscoveryConvention
    • NameOfRelatedTypeNameOfItsPK provided by TypeNameForeignKeyDiscoveryConvention
    • NameOfRelatedPK provided by PrimaryKeyNameForeignKeyDiscoveryConvention
  • In the last example you correctly defined FK property and EF detected it so it uses Foreign key association.
like image 108
Ladislav Mrnka Avatar answered Sep 19 '22 05:09

Ladislav Mrnka