How to set comment with `ComplexProperty`.

[whyfate]

Question

builder.ComplexProperty(b => b.ExtraInfo, b => b.ToJson().IsRequired(false)).HasComment("extra info");

This code will set comments on the table.

EF Core version

10.0.0

Database provider

Microsoft.EntityFrameworkCore.SqlServer

Target framework

.NET 10.0

[roji]

@AndriySvyryd it feels like there needs to be some way to get a PropertyBuilder to configure the JSON column; this would allow configuring the comment and any other column facet that makes sense. In theory, we could even actually model the JSON column as a regular property in addition to the complex property - this would allow users to e.g. query/update JSON columns as strings (though this probably isn't actually needed).

Of course, none of this applies to table splitting, where the complex property does not correspond to any column. This might be another place where the user-facing complex property "abstraction" is too abstract. In other words, if the user configured complex JSON via a dedicated JsonProperty() API (rather than ToJson on a complex property builder), we'd be able to more easily provide JSON-specific things.

[pinkfloydx33]

With ComplexCollection at least, there seems to be a way to add property annotations via HasPropertyAnnotation.

That said, I'm not sure if that's what it's supposed to be for, nor if it exists on ComplexProperty. It seems to be ignored--at least for the case I tried of changing DefaultValueSql--but maybe it works for some subset of annotations?

I'm not sure if it's related to the above or can be leveraged for the specific case mentioned in OP. (Otherwise, what is the purpose of it?)

builder.ComplexCollection(e => e.Events, e =>
{
    e.IsRequired();
    e.ToJson();
    
    // try to fix default of '{ }' 
    e.HasPropertyAnnotation(RelationalAnnotationNames.DefaultValueSql, "'[]'::JSONB");
});