How to add description to columns in Entity Framework Core code-first using migrations?

Question

I am using Entity Framework Core 3.0 code. How do I add descriptions for columns in entity configuration classes or migrations so that they end up as a column description in SQL Server?

There is a publication for Entity Framework 4.3.1 but I could not do it in the Entity Framework Core.

It would be easier for others to understand your problem if you share your code. — shuvo
– shuvo, Commented Dec 27, 2019 at 13:32

Ivan Stoev · Accepted Answer · 2019-12-27 15:32:37Z

15

You can use HasComment fluent API:

modelBuilder.Entity<MyEntity>()
    .Property(e => e.MyProperty)
    .HasComment("My Column Description");

For SqlServer this is mapped to the corresponding table column description.

answered Dec 27, 2019 at 15:32

Ivan Stoev

208k17 gold badges356 silver badges376 bronze badges

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

3 Comments

Joyce Couraça Over a year ago

Hello, I tried your suggestion, but an error occurs while creating as migration "Object reference not set to an instance of an object."

Ivan Stoev Over a year ago

Hi, I've tested it with EF Core 3.1, SqlServer and it worked for me.

Joyce Couraça Over a year ago

It works only after the table creation is finished, to add comments without the existing table in the database of this error, thanks so much for the help

Murad · Accepted Answer · 2022-11-09 15:31:52Z

9

I'm used CommentAttribute.

Data Annotations (EF Core 5.0 and above)

public class Box
{   
    [Comment("Width in centimeters")]
    public string Width { get; set; }
}

Fluent API

modelBuilder.Entity<Box>()
            .Property(b => b.Width)
            .HasComment("Width in centimeters");

Generated SQL script.

COMMENT ON COLUMN shipping.box.width IS 'Width in centimeters';

My stack EF Core 6.0 and PostgreSQL 14.2.

Microsoft documentation

edited Nov 9, 2022 at 15:31

answered Nov 9, 2022 at 15:26

Murad

3873 silver badges7 bronze badges

Collectives™ on Stack Overflow

How to add description to columns in Entity Framework Core code-first using migrations?

2 Answers 2

3 Comments

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

3 Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related