Skip to content

Make GetContainerColumnType() always return the expected type #37864

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
AndriySvyryd merged 6 commits into from
Mar 6, 2026
+83 −9
Merged

Make GetContainerColumnType() always return the expected type #37864

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
e9aa875
Initial plan
Copilot Mar 6, 2026
cf6d4c5
Make GetContainerColumnType() return the default JSON mapping type in…
Copilot Mar 6, 2026
f6b6f0a
Move default JSON type resolution from convention to GetContainerColu…
Copilot Mar 6, 2026
272f907
Remove redundant fallback in CSharpSnapshotGenerator now that GetCont…
Copilot Mar 6, 2026
cab6eeb
Cast model to Model and check IsReadOnly instead of checking for IModel
Copilot Mar 6, 2026
520417f
Use || condition for non-Model types and simplify IsReadOnly check
Copilot Mar 6, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 0 additions & 28 deletions src/EFCore.Design/Migrations/Design/CSharpSnapshotGenerator.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -703,20 +703,6 @@ protected virtual void GenerateComplexPropertyAnnotations(
.FilterIgnoredAnnotations(property.ComplexType.GetAnnotations())
.ToDictionary(a => a.Name, a => a);

// Add ContainerColumnType annotation if complex type is mapped to JSON but the type annotation is missing
if (typeAnnotations.ContainsKey(RelationalAnnotationNames.ContainerColumnName)
&& !typeAnnotations.ContainsKey(RelationalAnnotationNames.ContainerColumnType))
{
var containerColumnType = property.ComplexType.GetContainerColumnType()
?? Dependencies.RelationalTypeMappingSource.FindMapping(typeof(JsonTypePlaceholder))?.StoreType;
if (containerColumnType != null)
{
typeAnnotations[RelationalAnnotationNames.ContainerColumnType] = new Annotation(
RelationalAnnotationNames.ContainerColumnType,
containerColumnType);
}
}

GenerateAnnotations(
propertyBuilderName, property, stringBuilder, propertyAnnotations,
inChainedCall: false, hasAnnotationMethodInfo: HasPropertyAnnotationMethodInfo);
Expand Down Expand Up @@ -917,20 +903,6 @@ protected virtual void GenerateEntityTypeAnnotations(
.FilterIgnoredAnnotations(entityType.GetAnnotations())
.ToDictionary(a => a.Name, a => a);

// Add ContainerColumnType annotation if entity is mapped to JSON but the type annotation is missing
if (annotations.ContainsKey(RelationalAnnotationNames.ContainerColumnName)
&& !annotations.ContainsKey(RelationalAnnotationNames.ContainerColumnType))
{
var containerColumnType = entityType.GetContainerColumnType()
?? Dependencies.RelationalTypeMappingSource.FindMapping(typeof(JsonTypePlaceholder))?.StoreType;
if (containerColumnType != null)
{
annotations[RelationalAnnotationNames.ContainerColumnType] = new Annotation(
RelationalAnnotationNames.ContainerColumnType,
containerColumnType);
}
}

GenerateTableMapping(entityTypeBuilderName, entityType, stringBuilder, annotations);
GenerateSplitTableMapping(entityTypeBuilderName, entityType, stringBuilder);

Expand Down
35 changes: 35 additions & 0 deletions src/EFCore.Relational/Metadata/Conventions/RelationalMapToJsonConvention.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,8 +52,18 @@ public virtual void ProcessModelFinalizing(
IConventionModelBuilder modelBuilder,
IConventionContext<IConventionModelBuilder> context)
{
var defaultJsonStoreType =
Comment thread
AndriySvyryd marked this conversation as resolved.
Outdated
((RelationalTypeMapping?)Dependencies.TypeMappingSource.FindMapping(typeof(JsonTypePlaceholder)))?.StoreType;

foreach (var jsonEntityType in modelBuilder.Metadata.GetEntityTypes().Where(e => e.IsMappedToJson()))
{
if (defaultJsonStoreType != null
&& jsonEntityType.FindAnnotation(RelationalAnnotationNames.ContainerColumnName)?.Value is string
&& jsonEntityType.FindAnnotation(RelationalAnnotationNames.ContainerColumnType) == null)
{
jsonEntityType.SetContainerColumnType(defaultJsonStoreType);
}

foreach (var enumProperty in jsonEntityType
.GetDeclaredProperties()
.Where(p => p.ClrType.UnwrapNullableType().IsEnum))
Expand All @@ -67,5 +77,30 @@ public virtual void ProcessModelFinalizing(
}
}
}

if (defaultJsonStoreType != null)
{
foreach (var entityType in modelBuilder.Metadata.GetEntityTypes())
{
SetDefaultContainerColumnTypeForComplexTypes(entityType, defaultJsonStoreType);
}
}
}

private static void SetDefaultContainerColumnTypeForComplexTypes(
IConventionTypeBase typeBase,
string defaultJsonStoreType)
{
foreach (var complexProperty in typeBase.GetComplexProperties())
{
var complexType = complexProperty.ComplexType;
if (complexType.FindAnnotation(RelationalAnnotationNames.ContainerColumnName)?.Value is string
&& complexType.FindAnnotation(RelationalAnnotationNames.ContainerColumnType) == null)
{
complexType.SetContainerColumnType(defaultJsonStoreType);
}

SetDefaultContainerColumnTypeForComplexTypes(complexType, defaultJsonStoreType);
}
}
}
54 changes: 54 additions & 0 deletions test/EFCore.Relational.Tests/Metadata/RelationalModelTest.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3053,6 +3053,60 @@ public void Complex_collection_container_column_type_is_used_in_relational_model
Assert.Equal("some_json_mapping", column.StoreType);
}

[ConditionalFact]
public void Complex_property_gets_default_container_column_type_when_not_set_explicitly()
{
var modelBuilder = CreateConventionModelBuilder();

modelBuilder.Entity<EntityWithComplexProperty>(eb =>
{
eb.ComplexProperty(
e => e.ComplexProperty, cb =>
{
cb.ToJson("complex_data");
});
});

var model = Finalize(modelBuilder);

var entityType = model.Model.FindEntityType(typeof(EntityWithComplexProperty));
var complexProperty = entityType.GetComplexProperties().Single();
var complexType = complexProperty.ComplexType;

Assert.Equal("some_json_mapping", complexType.GetContainerColumnType());

var table = entityType.GetTableMappings().Single().Table;
var column = table.Columns.Single(c => c.Name == "complex_data");
Assert.Equal("some_json_mapping", column.StoreType);
}

[ConditionalFact]
public void Complex_collection_gets_default_container_column_type_when_not_set_explicitly()
{
var modelBuilder = CreateConventionModelBuilder();

modelBuilder.Entity<EntityWithComplexCollection>(eb =>
{
eb.ComplexCollection(
e => e.ComplexCollection, cb =>
{
cb.ToJson("collection_data");
});
});

var model = Finalize(modelBuilder);

var entityType = model.Model.FindEntityType(typeof(EntityWithComplexCollection));
var complexProperty = entityType.GetComplexProperties().Single();
var complexType = complexProperty.ComplexType;

Assert.Equal("some_json_mapping", complexType.GetContainerColumnType());

var table = entityType.GetTableMappings().Single().Table;
var column = table.Columns.Single(c => c.Name == "collection_data");
Assert.Equal("some_json_mapping", column.StoreType);
}

[ConditionalFact]
public void Can_use_relational_model_with_functions()
{
Expand Down
Loading