How to use custom property name for foreign key column in Entity Framework

Question

I for some reason cannot seem to find this info anywhere, but feel this would be a common thing. I originally had this class:

public class SiteSharingPermission
{
    [Required]
    public Guid Id { get; set; }

    public Guid OrganizationId { get; set; }
    public Organization Organization { get; set; }
}

I recently needed to modify this column / property (OrganizationId -> PartnerOrganizationId) but I'm having an issue with my migrations on updating the foreign key column property name.

I tried running migrations, modified the up/down to this:

    protected override void Up(MigrationBuilder migrationBuilder)
    {
        migrationBuilder.DropForeignKey(
            name: "FK_SiteSharingPermissions_Organizations_OrganizationId",
            table: "SiteSharingPermissions");

        migrationBuilder.RenameColumn(
            name: "OrganizationId",
            table: "SiteSharingPermissions",
            newName: "PartnerOrganizationId");

        migrationBuilder.AddForeignKey(
            name: "FK_SiteSharingPermissions_Organizations_PartnerOrganizationId",
            table: "SiteSharingPermissions",
            column: "PartnerOrganizationId",
            principalTable: "Organizations",
            principalColumn: "Id",
            onDelete: ReferentialAction.Restrict);
    }

    protected override void Down(MigrationBuilder migrationBuilder)
    {
        migrationBuilder.DropForeignKey(
            name: "FK_SiteSharingPermissions_Organizations_PartnerOrganizationId",
            table: "SiteSharingPermissions");

        migrationBuilder.RenameColumn(
            name: "PartnerOrganizationId",
            table: "SiteSharingPermissions",
            newName: "OrganizationId");

        migrationBuilder.AddForeignKey(
            name: "FK_SiteSharingPermissions_Organizations_OrganizationId",
            table: "SiteSharingPermissions",
            column: "OrganizationId",
            principalTable: "Organizations",
            principalColumn: "Id",
            onDelete: ReferentialAction.Cascade);
    }

But I keep getting an error when trying to get results from this table:

Unknown column 's.OrganizationId' in field list

Any ideas?

learn.microsoft.com/en-us/ef/core/modeling/… But maybe you have some raw sql? Perhaps in a view / procedure / trigger? — Jeremy Lakeman
– Jeremy Lakeman, Commented Mar 31, 2022 at 4:52

Akash Veer · Accepted Answer · 2022-03-31 13:45:32Z

2

I personally won't prefer making changes to migration file. Instead do something like below.

public class SiteSharingPermission
{
   [Required]
   public Guid Id { get; set; }

   public Guid PartnerOrganizationId { get; set; }
   [ForeignKey("PartnerOrganizationId")]
   public Organization Organization { get; set; }
}

You can also do it using Fluent API method.

answered Mar 31, 2022 at 13:45

Akash Veer

1801 gold badge3 silver badges14 bronze badges

Sign up to request clarification or add additional context in comments.

1 Comment

dlimes Over a year ago

Wow, I did not expect it to be that easy, thank you Akash Veer!

Collectives™ on Stack Overflow

How to use custom property name for foreign key column in Entity Framework

1 Answer 1

1 Comment

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

1 Comment

Your Answer

Sign up or log in

Post as a guest

Related