-
Notifications
You must be signed in to change notification settings - Fork 228
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Refactors method identification for translation
- Improves how we verify that: - an array or list is supported - the function for an array or list is supported. - Renames `NpgsqlListTranslator` to `NpgsqlArrayTranslator` - Adds `NpgsqlArrayExtensions`
- Loading branch information
1 parent
366f649
commit 07aa199
Showing
7 changed files
with
332 additions
and
120 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,92 @@ | ||
#region License | ||
|
||
// The PostgreSQL License | ||
// | ||
// Copyright (C) 2016 The Npgsql Development Team | ||
// | ||
// Permission to use, copy, modify, and distribute this software and its | ||
// documentation for any purpose, without fee, and without a written | ||
// agreement is hereby granted, provided that the above copyright notice | ||
// and this paragraph and the following two paragraphs appear in all copies. | ||
// | ||
// IN NO EVENT SHALL THE NPGSQL DEVELOPMENT TEAM BE LIABLE TO ANY PARTY | ||
// FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES, | ||
// INCLUDING LOST PROFITS, ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS | ||
// DOCUMENTATION, EVEN IF THE NPGSQL DEVELOPMENT TEAM HAS BEEN ADVISED OF | ||
// THE POSSIBILITY OF SUCH DAMAGE. | ||
// | ||
// THE NPGSQL DEVELOPMENT TEAM SPECIFICALLY DISCLAIMS ANY WARRANTIES, | ||
// INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY | ||
// AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS | ||
// ON AN "AS IS" BASIS, AND THE NPGSQL DEVELOPMENT TEAM HAS NO OBLIGATIONS | ||
// TO PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS. | ||
|
||
#endregion | ||
|
||
using System; | ||
using System.Collections.Generic; | ||
using JetBrains.Annotations; | ||
|
||
// ReSharper disable once CheckNamespace | ||
namespace Microsoft.EntityFrameworkCore | ||
{ | ||
/// <summary> | ||
/// Provides extension methods for <see cref="List{T}"/> supporting PostgreSQL translation. | ||
/// </summary> | ||
public static class NpgsqlArrayExtensions | ||
{ | ||
/// <summary> | ||
/// Determines whether a range contains a specified value. | ||
/// </summary> | ||
/// <param name="_">The DbFunctions instance.</param> | ||
/// <param name="array">The list to conver to a string in which to locate the value.</param> | ||
/// <param name="delimiter">The value used to delimit the elements.</param> | ||
/// <typeparam name="T">The type of the elements of <paramref name="array"/>.</typeparam> | ||
/// <returns> | ||
/// <value>true</value> if the range contains the specified value; otherwise, <value>false</value>. | ||
/// </returns> | ||
public static string ArrayToString<T>([CanBeNull] this DbFunctions _, [NotNull] T[] array, [CanBeNull] string delimiter) | ||
=> throw new NotSupportedException(); | ||
|
||
/// <summary> | ||
/// Determines whether a range contains a specified value. | ||
/// </summary> | ||
/// <param name="_">The DbFunctions instance.</param> | ||
/// <param name="array">The list to conver to a string in which to locate the value.</param> | ||
/// <param name="delimiter">The value used to delimit the elements.</param> | ||
/// <param name="nullString">The value used to represent a null value.</param> | ||
/// <typeparam name="T">The type of the elements of <paramref name="array"/>.</typeparam> | ||
/// <returns> | ||
/// <value>true</value> if the range contains the specified value; otherwise, <value>false</value>. | ||
/// </returns> | ||
public static string ArrayToString<T>([CanBeNull] this DbFunctions _, [NotNull] T[] array, [CanBeNull] string delimiter, [CanBeNull] string nullString) | ||
=> throw new NotSupportedException(); | ||
|
||
/// <summary> | ||
/// Determines whether a range contains a specified value. | ||
/// </summary> | ||
/// <param name="_">The DbFunctions instance.</param> | ||
/// <param name="list">The list to conver to a string in which to locate the value.</param> | ||
/// <param name="delimiter">The value used to delimit the elements.</param> | ||
/// <typeparam name="T">The type of the elements of <paramref name="list"/>.</typeparam> | ||
/// <returns> | ||
/// <value>true</value> if the range contains the specified value; otherwise, <value>false</value>. | ||
/// </returns> | ||
public static string ArrayToString<T>([CanBeNull] this DbFunctions _, [NotNull] List<T> list, [CanBeNull] string delimiter) | ||
=> throw new NotSupportedException(); | ||
|
||
/// <summary> | ||
/// Determines whether a range contains a specified value. | ||
/// </summary> | ||
/// <param name="_">The DbFunctions instance.</param> | ||
/// <param name="list">The list to conver to a string in which to locate the value.</param> | ||
/// <param name="delimiter">The value used to delimit the elements.</param> | ||
/// <param name="nullString">The value used to represent a null value.</param> | ||
/// <typeparam name="T">The type of the elements of <paramref name="list"/>.</typeparam> | ||
/// <returns> | ||
/// <value>true</value> if the range contains the specified value; otherwise, <value>false</value>. | ||
/// </returns> | ||
public static string ArrayToString<T>([CanBeNull] this DbFunctions _, [NotNull] List<T> list, [CanBeNull] string delimiter, [CanBeNull] string nullString) | ||
=> throw new NotSupportedException(); | ||
} | ||
} |
191 changes: 191 additions & 0 deletions
191
src/EFCore.PG/Query/ExpressionTranslators/Internal/NpgsqlArrayTranslator.cs
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,191 @@ | ||
#region License | ||
|
||
// The PostgreSQL License | ||
// | ||
// Copyright (C) 2016 The Npgsql Development Team | ||
// | ||
// Permission to use, copy, modify, and distribute this software and its | ||
// documentation for any purpose, without fee, and without a written | ||
// agreement is hereby granted, provided that the above copyright notice | ||
// and this paragraph and the following two paragraphs appear in all copies. | ||
// | ||
// IN NO EVENT SHALL THE NPGSQL DEVELOPMENT TEAM BE LIABLE TO ANY PARTY | ||
// FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES, | ||
// INCLUDING LOST PROFITS, ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS | ||
// DOCUMENTATION, EVEN IF THE NPGSQL DEVELOPMENT TEAM HAS BEEN ADVISED OF | ||
// THE POSSIBILITY OF SUCH DAMAGE. | ||
// | ||
// THE NPGSQL DEVELOPMENT TEAM SPECIFICALLY DISCLAIMS ANY WARRANTIES, | ||
// INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY | ||
// AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS | ||
// ON AN "AS IS" BASIS, AND THE NPGSQL DEVELOPMENT TEAM HAS NO OBLIGATIONS | ||
// TO PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS. | ||
|
||
#endregion | ||
|
||
using System; | ||
using System.Collections; | ||
using System.Collections.Generic; | ||
using System.Linq; | ||
using System.Linq.Expressions; | ||
using System.Reflection; | ||
using JetBrains.Annotations; | ||
using Microsoft.EntityFrameworkCore; | ||
using Microsoft.EntityFrameworkCore.Query.Expressions; | ||
using Microsoft.EntityFrameworkCore.Query.ExpressionTranslators; | ||
using Npgsql.EntityFrameworkCore.PostgreSQL.Query.Expressions.Internal; | ||
|
||
namespace Npgsql.EntityFrameworkCore.PostgreSQL.Query.ExpressionTranslators.Internal | ||
{ | ||
/// <summary> | ||
/// Provides translation services for PostgreSQL array operators mapped to methods declared on | ||
/// <see cref="Array"/>, <see cref="Enumerable"/>, <see cref="List{T}"/>, and <see cref="NpgsqlArrayExtensions"/>. | ||
/// </summary> | ||
/// <remarks> | ||
/// See: https://www.postgresql.org/docs/current/static/functions-array.html | ||
/// </remarks> | ||
public class NpgsqlArrayTranslator : IMethodCallTranslator | ||
{ | ||
/// <inheritdoc /> | ||
[CanBeNull] | ||
public Expression Translate(MethodCallExpression expression) | ||
{ | ||
if (!IsTypeSupported(expression)) | ||
return null; | ||
|
||
if (!IsMethodSupported(expression.Method)) | ||
return null; | ||
|
||
// TODO: use #430 to map @> to source.All(x => other.Contains(x)); | ||
// TODO: use #430 to map && to soucre.Any(x => other.Contains(x)); | ||
|
||
switch (expression.Method.Name) | ||
{ | ||
#region Instance | ||
|
||
case "get_Item" when expression.Object is Expression instance: | ||
return Expression.MakeIndex(instance, instance.Type.GetRuntimeProperty("Item"), expression.Arguments); | ||
|
||
#endregion | ||
|
||
#region Enumerable | ||
|
||
case nameof(Enumerable.ElementAt): | ||
return Expression.MakeIndex(expression.Arguments[0], expression.Arguments[0].Type.GetRuntimeProperty("Item"), new[] { expression.Arguments[1] }); | ||
|
||
// TODO: Currently handled in NpgsqlSqlTranslatingExpressionVisitor. | ||
case nameof(Enumerable.Append): | ||
case nameof(Enumerable.Concat) when IsArrayOrList(expression.Arguments[1].Type): | ||
return new CustomBinaryExpression(expression.Arguments[0], expression.Arguments[1], "||", expression.Arguments[0].Type); | ||
|
||
case nameof(Enumerable.Count): | ||
return new SqlFunctionExpression("array_length", typeof(int), new[] { expression.Arguments[0], Expression.Constant(1) }); | ||
|
||
case nameof(Enumerable.Prepend): | ||
return new CustomBinaryExpression(expression.Arguments[1], expression.Arguments[0], "||", expression.Arguments[0].Type); | ||
|
||
case nameof(Enumerable.SequenceEqual): | ||
return Expression.MakeBinary(ExpressionType.Equal, expression.Arguments[0], expression.Arguments[1]); | ||
|
||
#endregion | ||
|
||
#region NpgsqlArrayExtensions | ||
|
||
case nameof(NpgsqlArrayExtensions.ArrayToString): | ||
return new SqlFunctionExpression("array_to_string", typeof(string), expression.Arguments.Skip(1)); | ||
|
||
#endregion | ||
|
||
#region ArrayStatic | ||
|
||
case nameof(Array.IndexOf) when expression.Method.DeclaringType == typeof(Array): | ||
return | ||
new SqlFunctionExpression( | ||
"COALESCE", | ||
typeof(int), | ||
new Expression[] | ||
{ | ||
new SqlFunctionExpression("array_position", typeof(int), expression.Arguments), | ||
Expression.Constant(-1) | ||
}); | ||
|
||
#endregion | ||
|
||
#region ListInstance | ||
|
||
case nameof(IList.IndexOf) when IsArrayOrList(expression.Method.DeclaringType): | ||
return | ||
new SqlFunctionExpression( | ||
"COALESCE", | ||
typeof(int), | ||
new Expression[] | ||
{ | ||
new SqlFunctionExpression("array_position", typeof(int), new[] { expression.Object, expression.Arguments[0] }), | ||
Expression.Constant(-1) | ||
}); | ||
|
||
#endregion | ||
|
||
default: | ||
return null; | ||
} | ||
} | ||
|
||
#region Helpers | ||
|
||
/// <summary> | ||
/// Tests if the instance or argument types are supported. | ||
/// </summary> | ||
/// <param name="expression"> | ||
/// The <see cref="MethodCallExpression"/> to test. | ||
/// </param> | ||
/// <returns> | ||
/// True if the instance or argument types are supported; otherwise, false. | ||
/// </returns> | ||
static bool IsTypeSupported([NotNull] MethodCallExpression expression) | ||
{ | ||
if (expression.Object is Expression instance) | ||
return IsArrayOrList(instance.Type); | ||
|
||
if (expression.Object is null) | ||
{ | ||
if (expression.Arguments.Count == 0) | ||
return false; | ||
|
||
if (expression.Arguments.Count > 1 && | ||
expression.Arguments[0].Type == typeof(DbFunctions)) | ||
return IsArrayOrList(expression.Arguments[1].Type); | ||
|
||
return IsArrayOrList(expression.Arguments[0].Type); | ||
} | ||
|
||
return false; | ||
} | ||
|
||
/// <summary> | ||
/// Tests if the type is an array or a <see cref="List{T}"/>. | ||
/// </summary> | ||
/// <param name="type"> | ||
/// The type to test. | ||
/// </param> | ||
/// <returns> | ||
/// True if <paramref name="type"/> is an array or a <see cref="List{T}"/>; otherwise, false. | ||
/// </returns> | ||
static bool IsArrayOrList(Type type) | ||
=> type.IsArray || type.IsGenericType && typeof(List<>) == type.GetGenericTypeDefinition(); | ||
|
||
/// <summary> | ||
/// Tests if the method is declared on an array, a <see cref="List{T}"/>, or <see cref="Enumerable"/>. | ||
/// </summary> | ||
/// <param name="method"> | ||
/// The method to test. | ||
/// </param> | ||
/// <returns> | ||
/// True if <paramref name="method"/> is declared on an array, a <see cref="List{T}"/>, or <see cref="Enumerable"/>; otherwise, false. | ||
/// </returns> | ||
static bool IsMethodSupported([NotNull] MethodInfo method) | ||
=> method.DeclaringType is Type t && (IsArrayOrList(t) || t == typeof(Array) || t == typeof(Enumerable) || t == typeof(NpgsqlArrayExtensions)); | ||
|
||
#endregion | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
105 changes: 0 additions & 105 deletions
105
src/EFCore.PG/Query/ExpressionTranslators/Internal/NpgsqlListTranslator.cs
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.