Add NpgsqlCSharpRuntimeAnnotationCodeGenerator

Closes #2308
npgsql · Nov 17, 2023 · 9debbc9 · 9debbc9
1 parent 7be1f48
commit 9debbc9
Show file tree

Hide file tree

Showing 2 changed files with 230 additions and 1 deletion.
diff --git a/src/EFCore.PG/Design/Internal/NpgsqlCSharpRuntimeAnnotationCodeGenerator.cs b/src/EFCore.PG/Design/Internal/NpgsqlCSharpRuntimeAnnotationCodeGenerator.cs
@@ -0,0 +1,225 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+
+using Microsoft.EntityFrameworkCore.Design.Internal;
+using Npgsql.EntityFrameworkCore.PostgreSQL.Metadata.Internal;
+
+namespace Npgsql.EntityFrameworkCore.PostgreSQL.Design.Internal;
+
+/// <summary>
+///     This is an internal API that supports the Entity Framework Core infrastructure and not subject to
+///     the same compatibility standards as public APIs. It may be changed or removed without notice in
+///     any release. You should only use it directly in your code with extreme caution and knowing that
+///     doing so can result in application failures when updating to a new Entity Framework Core release.
+/// </summary>
+#pragma warning disable EF1001 // Internal EF Core API usage.
+public class NpgsqlCSharpRuntimeAnnotationCodeGenerator : RelationalCSharpRuntimeAnnotationCodeGenerator
+{
+    /// <summary>
+    ///     This is an internal API that supports the Entity Framework Core infrastructure and not subject to
+    ///     the same compatibility standards as public APIs. It may be changed or removed without notice in
+    ///     any release. You should only use it directly in your code with extreme caution and knowing that
+    ///     doing so can result in application failures when updating to a new Entity Framework Core release.
+    /// </summary>
+    public NpgsqlCSharpRuntimeAnnotationCodeGenerator(
+        CSharpRuntimeAnnotationCodeGeneratorDependencies dependencies,
+        RelationalCSharpRuntimeAnnotationCodeGeneratorDependencies relationalDependencies)
+        : base(dependencies, relationalDependencies)
+    {
+    }
+
+    /// <inheritdoc />
+    public override void Generate(IModel model, CSharpRuntimeAnnotationCodeGeneratorParameters parameters)
+    {
+        if (!parameters.IsRuntime)
+        {
+            var annotations = parameters.Annotations;
+            annotations.Remove(NpgsqlAnnotationNames.DatabaseTemplate);
+            annotations.Remove(NpgsqlAnnotationNames.Tablespace);
+            annotations.Remove(NpgsqlAnnotationNames.CollationDefinitionPrefix);
+
+#pragma warning disable CS0618
+            annotations.Remove(NpgsqlAnnotationNames.DefaultColumnCollation);
+#pragma warning restore CS0618
+
+            foreach (var annotationName in annotations.Keys.Where(
+                         k =>
+                             k.StartsWith(NpgsqlAnnotationNames.PostgresExtensionPrefix, StringComparison.Ordinal)
+                             || k.StartsWith(NpgsqlAnnotationNames.EnumPrefix, StringComparison.Ordinal)
+                             || k.StartsWith(NpgsqlAnnotationNames.RangePrefix, StringComparison.Ordinal)))
+            {
+                annotations.Remove(annotationName);
+            }
+        }
+
+        base.Generate(model, parameters);
+    }
+
+    /// <inheritdoc />
+    public override void Generate(IRelationalModel model, CSharpRuntimeAnnotationCodeGeneratorParameters parameters)
+    {
+        if (!parameters.IsRuntime)
+        {
+            var annotations = parameters.Annotations;
+            annotations.Remove(NpgsqlAnnotationNames.DatabaseTemplate);
+            annotations.Remove(NpgsqlAnnotationNames.Tablespace);
+            annotations.Remove(NpgsqlAnnotationNames.CollationDefinitionPrefix);
+
+#pragma warning disable CS0618
+            annotations.Remove(NpgsqlAnnotationNames.DefaultColumnCollation);
+#pragma warning restore CS0618
+
+            foreach (var annotationName in annotations.Keys.Where(
+                         k =>
+                             k.StartsWith(NpgsqlAnnotationNames.PostgresExtensionPrefix, StringComparison.Ordinal)
+                             || k.StartsWith(NpgsqlAnnotationNames.EnumPrefix, StringComparison.Ordinal)
+                             || k.StartsWith(NpgsqlAnnotationNames.RangePrefix, StringComparison.Ordinal)))
+            {
+                annotations.Remove(annotationName);
+            }
+        }
+
+        base.Generate(model, parameters);
+    }
+
+    /// <inheritdoc />
+    public override void Generate(IProperty property, CSharpRuntimeAnnotationCodeGeneratorParameters parameters)
+    {
+        if (!parameters.IsRuntime)
+        {
+            var annotations = parameters.Annotations;
+            annotations.Remove(NpgsqlAnnotationNames.IdentityOptions);
+            annotations.Remove(NpgsqlAnnotationNames.TsVectorConfig);
+            annotations.Remove(NpgsqlAnnotationNames.TsVectorProperties);
+            annotations.Remove(NpgsqlAnnotationNames.CompressionMethod);
+
+            if (!annotations.ContainsKey(NpgsqlAnnotationNames.ValueGenerationStrategy))
+            {
+                annotations[NpgsqlAnnotationNames.ValueGenerationStrategy] = property.GetValueGenerationStrategy();
+            }
+        }
+
+        base.Generate(property, parameters);
+    }
+
+    /// <inheritdoc />
+    public override void Generate(IColumn column, CSharpRuntimeAnnotationCodeGeneratorParameters parameters)
+    {
+        if (!parameters.IsRuntime)
+        {
+            var annotations = parameters.Annotations;
+
+            annotations.Remove(NpgsqlAnnotationNames.IdentityOptions);
+            annotations.Remove(NpgsqlAnnotationNames.TsVectorConfig);
+            annotations.Remove(NpgsqlAnnotationNames.TsVectorProperties);
+            annotations.Remove(NpgsqlAnnotationNames.CompressionMethod);
+        }
+
+        base.Generate(column, parameters);
+    }
+
+    /// <inheritdoc />
+    public override void Generate(IIndex index, CSharpRuntimeAnnotationCodeGeneratorParameters parameters)
+    {
+        if (!parameters.IsRuntime)
+        {
+            var annotations = parameters.Annotations;
+
+            annotations.Remove(RelationalAnnotationNames.Collation);
+            annotations.Remove(NpgsqlAnnotationNames.IndexMethod);
+            annotations.Remove(NpgsqlAnnotationNames.IndexOperators);
+            annotations.Remove(NpgsqlAnnotationNames.IndexSortOrder);
+            annotations.Remove(NpgsqlAnnotationNames.IndexNullSortOrder);
+            annotations.Remove(NpgsqlAnnotationNames.IndexInclude);
+            annotations.Remove(NpgsqlAnnotationNames.CreatedConcurrently);
+            annotations.Remove(NpgsqlAnnotationNames.NullsDistinct);
+
+            foreach (var annotationName in annotations.Keys.Where(
+                         k => k.StartsWith(NpgsqlAnnotationNames.StorageParameterPrefix, StringComparison.Ordinal)))
+            {
+                annotations.Remove(annotationName);
+            }
+        }
+
+        base.Generate(index, parameters);
+    }
+
+    /// <inheritdoc />
+    public override void Generate(ITableIndex index, CSharpRuntimeAnnotationCodeGeneratorParameters parameters)
+    {
+        if (!parameters.IsRuntime)
+        {
+            var annotations = parameters.Annotations;
+
+            annotations.Remove(RelationalAnnotationNames.Collation);
+            annotations.Remove(NpgsqlAnnotationNames.IndexMethod);
+            annotations.Remove(NpgsqlAnnotationNames.IndexOperators);
+            annotations.Remove(NpgsqlAnnotationNames.IndexSortOrder);
+            annotations.Remove(NpgsqlAnnotationNames.IndexNullSortOrder);
+            annotations.Remove(NpgsqlAnnotationNames.IndexInclude);
+            annotations.Remove(NpgsqlAnnotationNames.CreatedConcurrently);
+            annotations.Remove(NpgsqlAnnotationNames.NullsDistinct);
+
+            foreach (var annotationName in annotations.Keys.Where(
+                         k => k.StartsWith(NpgsqlAnnotationNames.StorageParameterPrefix, StringComparison.Ordinal)))
+            {
+                annotations.Remove(annotationName);
+            }
+        }
+
+        base.Generate(index, parameters);
+    }
+
+    /// <inheritdoc />
+    public override void Generate(IEntityType entityType, CSharpRuntimeAnnotationCodeGeneratorParameters parameters)
+    {
+        if (!parameters.IsRuntime)
+        {
+            var annotations = parameters.Annotations;
+
+            annotations.Remove(NpgsqlAnnotationNames.UnloggedTable);
+            annotations.Remove(CockroachDbAnnotationNames.InterleaveInParent);
+
+            foreach (var annotationName in annotations.Keys.Where(
+                         k => k.StartsWith(NpgsqlAnnotationNames.StorageParameterPrefix, StringComparison.Ordinal)))
+            {
+                annotations.Remove(annotationName);
+            }
+        }
+
+        base.Generate(entityType, parameters);
+    }
+
+    /// <inheritdoc />
+    public override void Generate(ITable table, CSharpRuntimeAnnotationCodeGeneratorParameters parameters)
+    {
+        if (!parameters.IsRuntime)
+        {
+            var annotations = parameters.Annotations;
+
+            annotations.Remove(NpgsqlAnnotationNames.UnloggedTable);
+            annotations.Remove(CockroachDbAnnotationNames.InterleaveInParent);
+
+            foreach (var annotationName in annotations.Keys.Where(
+                         k => k.StartsWith(NpgsqlAnnotationNames.StorageParameterPrefix, StringComparison.Ordinal)))
+            {
+                annotations.Remove(annotationName);
+            }
+        }
+
+        base.Generate(table, parameters);
+    }
+
+    /// <inheritdoc />
+    public override void Generate(IRelationalPropertyOverrides overrides, CSharpRuntimeAnnotationCodeGeneratorParameters parameters)
+    {
+        if (!parameters.IsRuntime)
+        {
+            var annotations = parameters.Annotations;
+            annotations.Remove(NpgsqlAnnotationNames.IdentityIncrement);
+            annotations.Remove(NpgsqlAnnotationNames.IdentitySeed);
+        }
+
+        base.Generate(overrides, parameters);
+    }
+}
diff --git a/src/EFCore.PG/Design/Internal/NpgsqlDesignTimeServices.cs b/src/EFCore.PG/Design/Internal/NpgsqlDesignTimeServices.cs
@@ -1,4 +1,5 @@
-using Npgsql.EntityFrameworkCore.PostgreSQL.Scaffolding.Internal;
+using Microsoft.EntityFrameworkCore.Design.Internal;
+using Npgsql.EntityFrameworkCore.PostgreSQL.Scaffolding.Internal;
 
 namespace Npgsql.EntityFrameworkCore.PostgreSQL.Design.Internal;
 
@@ -21,7 +22,10 @@ public virtual void ConfigureDesignTimeServices(IServiceCollection serviceCollec
         Check.NotNull(serviceCollection, nameof(serviceCollection));
 
         serviceCollection.AddEntityFrameworkNpgsql();
+#pragma warning disable EF1001 // Internal EF Core API usage.
         new EntityFrameworkRelationalDesignServicesBuilder(serviceCollection)
+            .TryAdd<ICSharpRuntimeAnnotationCodeGenerator, NpgsqlCSharpRuntimeAnnotationCodeGenerator>()
+#pragma warning restore EF1001 // Internal EF Core API usage.
             .TryAdd<IAnnotationCodeGenerator, NpgsqlAnnotationCodeGenerator>()
             .TryAdd<IDatabaseModelFactory, NpgsqlDatabaseModelFactory>()
             .TryAdd<IProviderConfigurationCodeGenerator, NpgsqlCodeGenerator>()