Add a read-optimized implementation of relational metadata.

Part of #8258

src/EFCore.Cosmos/Storage/Internal/CosmosClientWrapper.cs

@@ -419,7 +419,7 @@ public virtual async Task<bool> DeleteItemOnceAsync(
         {
             var entry = parameters.Entry;
             var items = Client.GetDatabase(_databaseId).GetContainer(parameters.ContainerId);
-            
+
             var itemRequestOptions = CreateItemRequestOptions(entry);
             var partitionKey = CreatePartitionKey(entry);
 

src/EFCore.Design/Migrations/Internal/SnapshotModelProcessor.cs

@@ -157,7 +157,7 @@ private void UpdateSequences(IReadOnlyModel model, string version)
                 .Select(a => new Sequence(model, a.Name));
 #pragma warning restore CS0618 // Type or member is obsolete
 
-            var sequencesDictionary = new SortedDictionary<(string, string?), Sequence>();
+            var sequencesDictionary = new SortedDictionary<(string, string?), ISequence>();
             foreach (var sequence in sequences)
             {
                 sequencesDictionary[(sequence.Name, sequence.Schema)] = sequence;

src/EFCore.Relational/Extensions/RelationalEntityTypeExtensions.cs

@@ -445,10 +445,10 @@ public static string GetDefaultSqlQueryName([NotNull] this IReadOnlyEntityType e
         /// <returns> The SQL string used to provide data for the entity type. </returns>
         public static string? GetSqlQuery([NotNull] this IReadOnlyEntityType entityType)
         {
-            var nameAnnotation = (string?)entityType[RelationalAnnotationNames.SqlQuery];
-            if (nameAnnotation != null)
+            var queryAnnotation = (string?)entityType[RelationalAnnotationNames.SqlQuery];
+            if (queryAnnotation != null)
             {
-                return nameAnnotation;
+                return queryAnnotation;
             }
 
             if (entityType.BaseType != null)
@@ -706,14 +706,14 @@ public static IEnumerable<IReadOnlyCheckConstraint> GetCheckConstraints([NotNull
         /// </summary>
         /// <param name="entityType"> The entity type to get the check constraints for. </param>
         public static IEnumerable<IMutableCheckConstraint> GetCheckConstraints([NotNull] this IMutableEntityType entityType)
-            => CheckConstraint.GetCheckConstraints(entityType);
+            => CheckConstraint.GetCheckConstraints(entityType).Cast<IMutableCheckConstraint>();
 
         /// <summary>
         ///     Returns all <see cref="IConventionCheckConstraint" /> contained in the entity type.
         /// </summary>
         /// <param name="entityType"> The entity type to get the check constraints for. </param>
         public static IEnumerable<IConventionCheckConstraint> GetCheckConstraints([NotNull] this IConventionEntityType entityType)
-            => CheckConstraint.GetCheckConstraints(entityType);
+            => CheckConstraint.GetCheckConstraints(entityType).Cast<IConventionCheckConstraint>();
 
         /// <summary>
         ///     Returns all <see cref="ICheckConstraint" /> contained in the entity type.

src/EFCore.Relational/Extensions/RelationalModelBuilderExtensions.cs

@@ -217,7 +217,7 @@ private static Sequence HasSequence(
             Check.NotEmpty(name, nameof(name));
             Check.NullButNotEmpty(schema, nameof(schema));
 
-            var sequence = Sequence.FindSequence(model, name, schema);
+            var sequence = (Sequence?)Sequence.FindSequence(model, name, schema);
             if (sequence != null)
             {
                 sequence.UpdateConfigurationSource(configurationSource);

src/EFCore.Relational/Extensions/RelationalModelExtensions.cs

@@ -3,6 +3,7 @@
 
 using System;
 using System.Collections.Generic;
+using System.Linq;
 using System.Reflection;
 using JetBrains.Annotations;
 using Microsoft.EntityFrameworkCore.Diagnostics;
@@ -257,14 +258,14 @@ public static IEnumerable<ISequence> GetSequences([NotNull] this IModel model)
         /// </summary>
         /// <param name="model"> The model to get the sequences in. </param>
         public static IEnumerable<IMutableSequence> GetSequences([NotNull] this IMutableModel model)
-            => Sequence.GetSequences(Check.NotNull(model, nameof(model)));
+            => Sequence.GetSequences(Check.NotNull(model, nameof(model))).Cast<IMutableSequence>();
 
         /// <summary>
         ///     Returns all sequences contained in the model.
         /// </summary>
         /// <param name="model"> The model to get the sequences in. </param>
         public static IEnumerable<IConventionSequence> GetSequences([NotNull] this IConventionModel model)
-            => Sequence.GetSequences(Check.NotNull(model, nameof(model)));
+            => Sequence.GetSequences(Check.NotNull(model, nameof(model))).Cast<IConventionSequence>();
 
         /// <summary>
         ///     Returns all sequences contained in the model.
@@ -463,14 +464,14 @@ public static IEnumerable<IReadOnlyDbFunction> GetDbFunctions([NotNull] this IMo
         /// </summary>
         /// <param name="model"> The model to get the functions in. </param>
         public static IEnumerable<IMutableDbFunction> GetDbFunctions([NotNull] this IMutableModel model)
-            => DbFunction.GetDbFunctions((Model)Check.NotNull(model, nameof(model)));
+            => DbFunction.GetDbFunctions((Model)Check.NotNull(model, nameof(model))).Cast<IMutableDbFunction>();
 
         /// <summary>
         ///     Returns all functions contained in the model.
         /// </summary>
         /// <param name="model"> The model to get the functions in. </param>
         public static IEnumerable<IConventionDbFunction> GetDbFunctions([NotNull] this IConventionModel model)
-            => DbFunction.GetDbFunctions((Model)Check.NotNull(model, nameof(model)));
+            => DbFunction.GetDbFunctions((Model)Check.NotNull(model, nameof(model))).Cast<IConventionDbFunction>();
 
         /// <summary>
         ///     Returns all functions contained in the model.

src/EFCore.Relational/Extensions/RelationalPropertyBuilderExtensions.cs

@@ -123,7 +123,7 @@ public static bool CanSetColumnName(
             in StoreObjectIdentifier storeObject,
             bool fromDataAnnotation = false)
         {
-            var overrides = RelationalPropertyOverrides.Find(propertyBuilder.Metadata, storeObject);
+            var overrides = (RelationalPropertyOverrides?)RelationalPropertyOverrides.Find(propertyBuilder.Metadata, storeObject);
             return overrides == null
                 || (fromDataAnnotation ? ConfigurationSource.DataAnnotation : ConfigurationSource.Convention)
                 .Overrides(overrides.GetColumnNameConfigurationSource())

src/EFCore.Relational/Extensions/RelationalPropertyExtensions.cs

@@ -51,7 +51,7 @@ public static string GetColumnBaseName([NotNull] this IReadOnlyProperty property
             Check.NotNull(property, nameof(property));
 
             var overrides = RelationalPropertyOverrides.Find(property, storeObject);
-            if (overrides?.GetColumnNameConfigurationSource() != null)
+            if (overrides?.ColumnNameOverriden == true)
             {
                 return overrides.ColumnName;
             }
@@ -276,7 +276,7 @@ public static void SetColumnName(
         public static ConfigurationSource? GetColumnNameConfigurationSource(
             [NotNull] this IConventionProperty property,
             in StoreObjectIdentifier storeObject)
-            => RelationalPropertyOverrides.Find(property, storeObject)?.GetColumnNameConfigurationSource();
+            => ((RelationalPropertyOverrides?)RelationalPropertyOverrides.Find(property, storeObject))?.GetColumnNameConfigurationSource();
 
         /// <summary>
         ///     Returns the database type of the column to which the property is mapped, or <see langword="null" /> if the database type
@@ -1063,8 +1063,7 @@ public static void SetComment([NotNull] this IMutableProperty property, [CanBeNu
         /// <param name="property"> The property. </param>
         /// <returns> The <see cref="ConfigurationSource" /> for the column comment. </returns>
         public static ConfigurationSource? GetCommentConfigurationSource([NotNull] this IConventionProperty property)
-            => property.FindAnnotation(RelationalAnnotationNames.Comment)
-                ?.GetConfigurationSource();
+            => property.FindAnnotation(RelationalAnnotationNames.Comment)?.GetConfigurationSource();
 
         /// <summary>
         ///     Returns the collation to be used for the column.
@@ -1365,7 +1364,7 @@ public static RelationalTypeMapping GetRelationalTypeMapping([NotNull] this IRea
         /// <param name="storeObject"> The identifier of the table-like store object containing the column. </param>
         /// <returns> An object that stores property facet overrides. </returns>
         public static IMutableAnnotatable? FindOverrides([NotNull] this IMutableProperty property, in StoreObjectIdentifier storeObject)
-            => RelationalPropertyOverrides.Find(property, storeObject);
+            => (IMutableAnnotatable?)RelationalPropertyOverrides.Find(property, storeObject);
 
         /// <summary>
         ///     <para>
@@ -1380,7 +1379,7 @@ public static RelationalTypeMapping GetRelationalTypeMapping([NotNull] this IRea
         /// <param name="storeObject"> The identifier of the table-like store object containing the column. </param>
         /// <returns> An object that stores property facet overrides. </returns>
         public static IConventionAnnotatable? FindOverrides([NotNull] this IConventionProperty property, in StoreObjectIdentifier storeObject)
-            => RelationalPropertyOverrides.Find(property, storeObject);
+            => (IConventionAnnotatable?)RelationalPropertyOverrides.Find(property, storeObject);
 
         /// <summary>
         ///     <para>
@@ -1395,7 +1394,7 @@ public static RelationalTypeMapping GetRelationalTypeMapping([NotNull] this IRea
         /// <param name="storeObject"> The identifier of the table-like store object containing the column. </param>
         /// <returns> An object that stores property facet overrides. </returns>
         public static IAnnotatable? FindOverrides([NotNull] this IProperty property, in StoreObjectIdentifier storeObject)
-            => RelationalPropertyOverrides.Find(property, storeObject);
+            => (IAnnotatable?)RelationalPropertyOverrides.Find(property, storeObject);
 
         /// <summary>
         ///     <para>
@@ -1412,7 +1411,7 @@ public static RelationalTypeMapping GetRelationalTypeMapping([NotNull] this IRea
         public static IMutableAnnotatable GetOrCreateOverrides(
             [NotNull] this IMutableProperty property,
             in StoreObjectIdentifier storeObject)
-            => RelationalPropertyOverrides.GetOrCreate(property, storeObject);
+            => (IMutableAnnotatable)RelationalPropertyOverrides.GetOrCreate(property, storeObject);
 
         /// <summary>
         ///     <para>
@@ -1429,6 +1428,6 @@ public static IMutableAnnotatable GetOrCreateOverrides(
         public static IConventionAnnotatable GetOrCreateOverrides(
             [NotNull] this IConventionProperty property,
             in StoreObjectIdentifier storeObject)
-            => RelationalPropertyOverrides.GetOrCreate(property, storeObject);
+            => (IConventionAnnotatable)RelationalPropertyOverrides.GetOrCreate(property, storeObject);
     }
 }

src/EFCore.Relational/Infrastructure/RelationalModelValidator.cs

@@ -1194,7 +1194,7 @@ protected virtual void ValidatePropertyOverrides(
             {
                 foreach (var property in entityType.GetDeclaredProperties())
                 {
-                    var tableOverrides = (SortedDictionary<StoreObjectIdentifier, RelationalPropertyOverrides>?)
+                    var tableOverrides = (SortedDictionary<StoreObjectIdentifier, IRelationalPropertyOverrides>?)
                         property[RelationalAnnotationNames.RelationalOverrides];
                     if (tableOverrides == null)
                     {

src/EFCore.Relational/Metadata/Conventions/SequenceUniquificationConvention.cs

@@ -41,7 +41,7 @@ public virtual void ProcessModelFinalizing(
         {
             var model = modelBuilder.Metadata;
             var modelSequences =
-                (SortedDictionary<(string Name, string Schema), Sequence>?)model[RelationalAnnotationNames.Sequences];
+                (SortedDictionary<(string Name, string? Schema), ISequence>?)model[RelationalAnnotationNames.Sequences];
 
             if (modelSequences != null)
             {
@@ -55,7 +55,7 @@ public virtual void ProcessModelFinalizing(
                     var newSequenceName = Uniquifier.Uniquify(
                         sequence.Key.Name, modelSequences,
                         sequenceName => (sequenceName, schemaName), maxLength);
-                    Sequence.SetName((IMutableModel)model, sequence.Value, newSequenceName);
+                    Sequence.SetName((IMutableModel)model, (Sequence)sequence.Value, newSequenceName);
                 }
             }
         }

src/EFCore.Relational/Metadata/ICheckConstraint.cs

@@ -12,7 +12,7 @@ namespace Microsoft.EntityFrameworkCore.Metadata
     public interface ICheckConstraint : IReadOnlyCheckConstraint, IAnnotatable
     {
         /// <summary>
-        ///     Gets the <see cref="IEntityType" /> in which this check constraint is defined.
+        ///     Gets the entity type on which this check constraint is defined.
         /// </summary>
         new IEntityType EntityType { get; }
 

src/EFCore.Relational/Metadata/IConventionCheckConstraint.cs

@@ -9,14 +9,14 @@ namespace Microsoft.EntityFrameworkCore.Metadata
     public interface IConventionCheckConstraint : IReadOnlyCheckConstraint, IConventionAnnotatable
     {
         /// <summary>
-        ///     Gets the <see cref="IConventionEntityType" /> in which this check constraint is defined.
+        ///     Gets the entity type on which this check constraint is defined.
         /// </summary>
         new IConventionEntityType EntityType { get; }
 
         /// <summary>
-        ///     Gets the configuration source for this <see cref="IConventionCheckConstraint" />.
+        ///     Gets the configuration source for this check constraint.
         /// </summary>
-        /// <returns> The configuration source for <see cref="IConventionCheckConstraint" />. </returns>
+        /// <returns> The configuration source for this check constraint. </returns>
         ConfigurationSource GetConfigurationSource();
     }
 }

src/EFCore.Relational/Metadata/IConventionDbFunction.cs

@@ -11,8 +11,8 @@
 namespace Microsoft.EntityFrameworkCore.Metadata
 {
     /// <summary>
-    ///     Represents a relational database function in an <see cref="IConventionModel" /> in
-    ///     the a form that can be mutated while the model is being built.
+    ///     Represents a relational database function in a model in
+    ///     the form that can be mutated while the model is being built.
     /// </summary>
     public interface IConventionDbFunction : IReadOnlyDbFunction, IConventionAnnotatable
     {

src/EFCore.Relational/Metadata/IDbFunction.cs

@@ -7,8 +7,7 @@
 namespace Microsoft.EntityFrameworkCore.Metadata
 {
     /// <summary>
-    ///     Represents a relational database function in an <see cref="IModel" /> in
-    ///     the a form that can be mutated while the model is being built.
+    ///     Represents a relational database function in a model.
     /// </summary>
     public interface IDbFunction : IReadOnlyDbFunction, IAnnotatable
     {

src/EFCore.Relational/Metadata/IDbFunctionParameter.cs

@@ -2,7 +2,6 @@
 // Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
 
 using Microsoft.EntityFrameworkCore.Infrastructure;
-using Microsoft.EntityFrameworkCore.Storage;
 
 namespace Microsoft.EntityFrameworkCore.Metadata
 {
@@ -11,6 +10,11 @@ namespace Microsoft.EntityFrameworkCore.Metadata
     /// </summary>
     public interface IDbFunctionParameter : IReadOnlyDbFunctionParameter, IAnnotatable
     {
+        /// <summary>
+        ///     Gets the store type of this parameter.
+        /// </summary>
+        new string StoreType { get; }
+
         /// <summary>
         ///     Gets the function to which this parameter belongs.
         /// </summary>

src/EFCore.Relational/Metadata/IMutableCheckConstraint.cs

@@ -9,7 +9,7 @@ namespace Microsoft.EntityFrameworkCore.Metadata
     public interface IMutableCheckConstraint : IReadOnlyCheckConstraint, IMutableAnnotatable
     {
         /// <summary>
-        ///     Gets the <see cref="IMutableEntityType" /> in which this check constraint is defined.
+        ///     Gets the entity type on which this check constraint is defined.
         /// </summary>
         new IMutableEntityType EntityType { get; }
     }

src/EFCore.Relational/Metadata/IMutableDbFunction.cs

@@ -10,8 +10,8 @@
 namespace Microsoft.EntityFrameworkCore.Metadata
 {
     /// <summary>
-    ///     Represents a relational database function in an <see cref="IMutableModel" /> in
-    ///     the a form that can be mutated while the model is being built.
+    ///     Represents a relational database function in an model in
+    ///     the form that can be mutated while the model is being built.
     /// </summary>
     public interface IMutableDbFunction : IReadOnlyDbFunction, IMutableAnnotatable
     {

src/EFCore.Relational/Metadata/IReadOnlyCheckConstraint.cs

@@ -16,7 +16,7 @@ public interface IReadOnlyCheckConstraint : IReadOnlyAnnotatable
         string Name { get; }
 
         /// <summary>
-        ///     Gets the <see cref="IReadOnlyEntityType" /> in which this check constraint is defined.
+        ///     Gets the entity type on which this check constraint is defined.
         /// </summary>
         IReadOnlyEntityType EntityType { get; }
 

src/EFCore.Relational/Metadata/IReadOnlyDbFunction.cs

@@ -14,7 +14,7 @@
 namespace Microsoft.EntityFrameworkCore.Metadata
 {
     /// <summary>
-    ///     Represents a relational database function in an <see cref="IReadOnlyModel" />.
+    ///     Represents a relational database function in a model.
     /// </summary>
     public interface IReadOnlyDbFunction : IReadOnlyAnnotatable
     {

src/EFCore.Relational/Metadata/IReadOnlyDbFunctionParameter.cs

@@ -9,7 +9,7 @@
 namespace Microsoft.EntityFrameworkCore.Metadata
 {
     /// <summary>
-    ///     Represents a <see cref="IReadOnlyDbFunction" /> parameter.
+    ///     Represents a function parameter.
     /// </summary>
     public interface IReadOnlyDbFunctionParameter : IReadOnlyAnnotatable
     {
@@ -34,8 +34,8 @@ public interface IReadOnlyDbFunctionParameter : IReadOnlyAnnotatable
         string? StoreType { get; }
 
         /// <summary>
-        ///     Gets the value which indicates whether parameter propagates nullability, meaning if it's value is null the database function itself
-        ///     returns null.
+        ///     Gets the value which indicates whether the parameter propagates nullability,
+        ///     meaning if it's value is <see langword="null"/> the database function itself returns <see langword="null"/>.
         /// </summary>
         bool PropagatesNullability { get; }
 

src/EFCore.Relational/Metadata/IReadOnlySequence.cs

@@ -23,7 +23,7 @@ public interface IReadOnlySequence : IReadOnlyAnnotatable
         string? Schema { get; }
 
         /// <summary>
-        ///     Gets the <see cref="IReadOnlyModel" /> in which this sequence is defined.
+        ///     Gets the model in which this sequence is defined.
         /// </summary>
         IReadOnlyModel Model { get; }
 

src/EFCore.Relational/Metadata/ISequence.cs

@@ -11,7 +11,7 @@ namespace Microsoft.EntityFrameworkCore.Metadata
     public interface ISequence : IReadOnlySequence, IAnnotatable
     {
         /// <summary>
-        ///     Gets the <see cref="IModel" /> in which this sequence is defined.
+        ///     Gets the model in which this sequence is defined.
         /// </summary>
         new IModel Model { get; }
     }