Query: API Cleanup (#20767)

dotnet · Apr 28, 2020 · c11deea · c11deea
1 parent f7080e0
commit c11deea
Show file tree

Hide file tree

Showing 31 changed files with 870 additions and 526 deletions.
diff --git a/src/EFCore.Relational/Query/CollectionInitializingExpression.cs b/src/EFCore.Relational/Query/CollectionInitializingExpression.cs
diff --git a/src/EFCore.Relational/Query/CollectionPopulatingExpression.cs b/src/EFCore.Relational/Query/CollectionPopulatingExpression.cs
diff --git a/src/EFCore.Relational/Query/EntityProjectionExpression.cs b/src/EFCore.Relational/Query/EntityProjectionExpression.cs
@@ -42,6 +42,10 @@ public EntityProjectionExpression([NotNull] IEntityType entityType, [NotNull] ID
             _propertyExpressionsCache = propertyExpressions;
         }
 
+        public virtual IEntityType EntityType { get; }
+        public sealed override ExpressionType NodeType => ExpressionType.Extension;
+        public override Type Type => EntityType.ClrType;
+
         protected override Expression VisitChildren(ExpressionVisitor visitor)
         {
             Check.NotNull(visitor, nameof(visitor));
@@ -109,10 +113,6 @@ public virtual EntityProjectionExpression UpdateEntityType([NotNull] IEntityType
             return new EntityProjectionExpression(derivedType, propertyExpressionCache);
         }
 
-        public virtual IEntityType EntityType { get; }
-        public sealed override ExpressionType NodeType => ExpressionType.Extension;
-        public override Type Type => EntityType.ClrType;
-
         public virtual ColumnExpression BindProperty([NotNull] IProperty property)
         {
             Check.NotNull(property, nameof(property));

diff --git a/src/EFCore.Relational/Query/ISqlExpressionFactory.cs b/src/EFCore.Relational/Query/ISqlExpressionFactory.cs
@@ -24,10 +24,12 @@ namespace Microsoft.EntityFrameworkCore.Query
     /// </summary>
     public interface ISqlExpressionFactory
     {
-        SqlExpression ApplyTypeMapping([CanBeNull] SqlExpression sqlExpression, [CanBeNull] RelationalTypeMapping typeMapping);
-        SqlExpression ApplyDefaultTypeMapping([CanBeNull] SqlExpression sqlExpression);
+        [Obsolete("Use IRelationalTypeMappingSource directly.")]
         RelationalTypeMapping GetTypeMappingForValue([CanBeNull] object value);
+        [Obsolete("Use IRelationalTypeMappingSource directly.")]
         RelationalTypeMapping FindMapping([NotNull] Type type);
+        SqlExpression ApplyTypeMapping([CanBeNull] SqlExpression sqlExpression, [CanBeNull] RelationalTypeMapping typeMapping);
+        SqlExpression ApplyDefaultTypeMapping([CanBeNull] SqlExpression sqlExpression);
 
         SqlUnaryExpression MakeUnary(
             ExpressionType operatorType,
@@ -43,9 +45,13 @@ SqlBinaryExpression MakeBinary(
 
         // Comparison
         SqlBinaryExpression Equal([NotNull] SqlExpression left, [NotNull] SqlExpression right);
+
         SqlBinaryExpression NotEqual([NotNull] SqlExpression left, [NotNull] SqlExpression right);
+
         SqlBinaryExpression GreaterThan([NotNull] SqlExpression left, [NotNull] SqlExpression right);
+
         SqlBinaryExpression GreaterThanOrEqual([NotNull] SqlExpression left, [NotNull] SqlExpression right);
+
         SqlBinaryExpression LessThan([NotNull] SqlExpression left, [NotNull] SqlExpression right);
 
         SqlBinaryExpression LessThanOrEqual([NotNull] SqlExpression left, [NotNull] SqlExpression right);
@@ -109,28 +115,30 @@ SqlFunctionExpression Function(
             [NotNull] Type returnType,
             [CanBeNull] RelationalTypeMapping typeMapping = null);
 
-        [Obsolete("Use overload that explicitly specifies value for 'argumentsPropagateNullability' argument.")]
+        [Obsolete("Use overload that explicitly specifies value for 'instancePropagatesNullability' and 'argumentsPropagateNullability' arguments.")]
         SqlFunctionExpression Function(
-            [CanBeNull] SqlExpression instance,
+            [NotNull] SqlExpression instance,
             [NotNull] string name,
             [NotNull] IEnumerable<SqlExpression> arguments,
             [NotNull] Type returnType,
             [CanBeNull] RelationalTypeMapping typeMapping = null);
 
+        [Obsolete("Use overload that explicitly specifies value for 'nullable' argument.")]
         SqlFunctionExpression Function(
             [NotNull] string name,
             [NotNull] Type returnType,
             [CanBeNull] RelationalTypeMapping typeMapping = null);
 
+        [Obsolete("Use overload that explicitly specifies value for 'nullable' argument.")]
         SqlFunctionExpression Function(
             [NotNull] string schema,
             [NotNull] string name,
             [NotNull] Type returnType,
             [CanBeNull] RelationalTypeMapping typeMapping = null);
 
-        [Obsolete("Use overload that explicitly specifies value for 'argumentsPropagateNullability' argument.")]
+        [Obsolete("Use overload that explicitly specifies value for 'instancePropagatesNullability' argument.")]
         SqlFunctionExpression Function(
-            [CanBeNull] SqlExpression instance,
+            [NotNull] SqlExpression instance,
             [NotNull] string name,
             [NotNull] Type returnType,
             [CanBeNull] RelationalTypeMapping typeMapping = null);
@@ -144,7 +152,7 @@ SqlFunctionExpression Function(
             [CanBeNull] RelationalTypeMapping typeMapping = null);
 
         SqlFunctionExpression Function(
-            [CanBeNull] string schema,
+            [NotNull] string schema,
             [NotNull] string name,
             [NotNull] IEnumerable<SqlExpression> arguments,
             bool nullable,
@@ -153,7 +161,7 @@ SqlFunctionExpression Function(
             [CanBeNull] RelationalTypeMapping typeMapping = null);
 
         SqlFunctionExpression Function(
-            [CanBeNull] SqlExpression instance,
+            [NotNull] SqlExpression instance,
             [NotNull] string name,
             [NotNull] IEnumerable<SqlExpression> arguments,
             bool nullable,
@@ -176,7 +184,7 @@ SqlFunctionExpression Function(
             [CanBeNull] RelationalTypeMapping typeMapping = null);
 
         SqlFunctionExpression Function(
-            [CanBeNull] SqlExpression instance,
+            [NotNull] SqlExpression instance,
             [NotNull] string name,
             bool nullable,
             bool instancePropagatesNullability,

diff --git a/src/EFCore.Relational/Query/Internal/CollateTranslator.cs b/src/EFCore.Relational/Query/Internal/CollateTranslator.cs
@@ -3,23 +3,28 @@
 
 using System.Collections.Generic;
 using System.Reflection;
-using JetBrains.Annotations;
-using Microsoft.EntityFrameworkCore.Internal;
 using Microsoft.EntityFrameworkCore.Query.SqlExpressions;
 using Microsoft.EntityFrameworkCore.Utilities;
 
 namespace Microsoft.EntityFrameworkCore.Query.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>
     public class CollateTranslator : IMethodCallTranslator
     {
         private static readonly MethodInfo _methodInfo
             = typeof(RelationalDbFunctionsExtensions).GetMethod(nameof(RelationalDbFunctionsExtensions.Collate));
 
-        private readonly ISqlExpressionFactory _sqlExpressionFactory;
-
-        public CollateTranslator([NotNull] ISqlExpressionFactory sqlExpressionFactory)
-            => _sqlExpressionFactory = sqlExpressionFactory;
-
+        /// <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 virtual SqlExpression Translate(SqlExpression instance, MethodInfo method, IReadOnlyList<SqlExpression> arguments)
         {
             Check.NotNull(method, nameof(method));