-
Notifications
You must be signed in to change notification settings - Fork 225
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Translate PostgreSQL custom aggregates (#2383)
* string_agg (string.Join) * array_agg * json_agg/jsonb_agg * json_object_agg/jsonb_object_agg * range_agg, range_intersect_agg * Aggregate statistics functions Closes #2395 Closes #532
- Loading branch information
Showing
12 changed files
with
1,332 additions
and
39 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
514 changes: 514 additions & 0 deletions
514
src/EFCore.PG/Extensions/DbFunctionsExtensions/NpgsqlAggregateDbFunctionsExtensions.cs
Large diffs are not rendered by default.
Oops, something went wrong.
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
158 changes: 158 additions & 0 deletions
158
src/EFCore.PG/Query/ExpressionTranslators/Internal/NpgsqlMiscAggregateMethodTranslator.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,158 @@ | ||
| using Npgsql.EntityFrameworkCore.PostgreSQL.Query.Expressions.Internal; | ||
| using Npgsql.EntityFrameworkCore.PostgreSQL.Storage.Internal.Mapping; | ||
| using static Npgsql.EntityFrameworkCore.PostgreSQL.Utilities.Statics; | ||
|
|
||
| namespace Npgsql.EntityFrameworkCore.PostgreSQL.Query.ExpressionTranslators.Internal; | ||
|
|
||
| public class NpgsqlMiscAggregateMethodTranslator : IAggregateMethodCallTranslator | ||
| { | ||
| private static readonly MethodInfo StringJoin | ||
| = typeof(string).GetRuntimeMethod(nameof(string.Join), new[] { typeof(string), typeof(IEnumerable<string>) })!; | ||
|
|
||
| private static readonly MethodInfo StringConcat | ||
| = typeof(string).GetRuntimeMethod(nameof(string.Concat), new[] { typeof(IEnumerable<string>) })!; | ||
|
|
||
| private readonly NpgsqlSqlExpressionFactory _sqlExpressionFactory; | ||
| private readonly IRelationalTypeMappingSource _typeMappingSource; | ||
|
|
||
| public NpgsqlMiscAggregateMethodTranslator( | ||
| NpgsqlSqlExpressionFactory sqlExpressionFactory, | ||
| IRelationalTypeMappingSource typeMappingSource) | ||
| { | ||
| _sqlExpressionFactory = sqlExpressionFactory; | ||
| _typeMappingSource = typeMappingSource; | ||
| } | ||
|
|
||
| public virtual SqlExpression? Translate( | ||
| MethodInfo method, | ||
| EnumerableExpression source, | ||
| IReadOnlyList<SqlExpression> arguments, | ||
| IDiagnosticsLogger<DbLoggerCategory.Query> logger) | ||
| { | ||
| // Docs: https://www.postgresql.org/docs/current/functions-aggregate.html | ||
|
|
||
| if (source.Selector is not SqlExpression sqlExpression) | ||
| { | ||
| return null; | ||
| } | ||
|
|
||
| if (method == StringJoin || method == StringConcat) | ||
| { | ||
| // string_agg filters out nulls, but string.Join treats them as empty strings; coalesce unless we know we're aggregating over | ||
| // a non-nullable column. | ||
| if (sqlExpression is not ColumnExpression { IsNullable: false }) | ||
| { | ||
| sqlExpression = _sqlExpressionFactory.Coalesce( | ||
| sqlExpression, | ||
| _sqlExpressionFactory.Constant(string.Empty, typeof(string))); | ||
| } | ||
|
|
||
| // string_agg returns null when there are no rows (or non-null values), but string.Join returns an empty string. | ||
| return _sqlExpressionFactory.Coalesce( | ||
| _sqlExpressionFactory.AggregateFunction( | ||
| "string_agg", | ||
| new[] | ||
| { | ||
| sqlExpression, | ||
| method == StringJoin ? arguments[0] : _sqlExpressionFactory.Constant(string.Empty, typeof(string)) | ||
| }, | ||
| source, | ||
| nullable: true, | ||
| argumentsPropagateNullability: new[] { false, true }, | ||
| typeof(string), | ||
| _typeMappingSource.FindMapping("text")), // Note that string_agg returns text even if its inputs are varchar(x) | ||
| _sqlExpressionFactory.Constant(string.Empty, typeof(string))); | ||
| } | ||
|
|
||
| if (method.DeclaringType == typeof(NpgsqlAggregateDbFunctionsExtensions)) | ||
| { | ||
| switch (method.Name) | ||
| { | ||
| case nameof(NpgsqlAggregateDbFunctionsExtensions.ArrayAgg): | ||
| var arrayClrType = sqlExpression.Type.MakeArrayType(); | ||
|
|
||
| return _sqlExpressionFactory.AggregateFunction( | ||
| "array_agg", | ||
| new[] { sqlExpression }, | ||
| source, | ||
| nullable: true, | ||
| argumentsPropagateNullability: FalseArrays[1], | ||
| returnType: arrayClrType, | ||
| typeMapping: sqlExpression.TypeMapping is null | ||
| ? null | ||
| : new NpgsqlArrayArrayTypeMapping(arrayClrType, sqlExpression.TypeMapping)); | ||
|
|
||
| case nameof(NpgsqlAggregateDbFunctionsExtensions.JsonAgg): | ||
| arrayClrType = sqlExpression.Type.MakeArrayType(); | ||
|
|
||
| return _sqlExpressionFactory.AggregateFunction( | ||
| "json_agg", | ||
| new[] { sqlExpression }, | ||
| source, | ||
| nullable: true, | ||
| argumentsPropagateNullability: FalseArrays[1], | ||
| returnType: arrayClrType, | ||
| _typeMappingSource.FindMapping(arrayClrType, "json")); | ||
|
|
||
| case nameof(NpgsqlAggregateDbFunctionsExtensions.JsonbAgg): | ||
| arrayClrType = sqlExpression.Type.MakeArrayType(); | ||
|
|
||
| return _sqlExpressionFactory.AggregateFunction( | ||
| "jsonb_agg", | ||
| new[] { sqlExpression }, | ||
| source, | ||
| nullable: true, | ||
| argumentsPropagateNullability: FalseArrays[1], | ||
| returnType: arrayClrType, | ||
| _typeMappingSource.FindMapping(arrayClrType, "jsonb")); | ||
|
|
||
| case nameof(NpgsqlAggregateDbFunctionsExtensions.RangeAgg): | ||
| arrayClrType = sqlExpression.Type.MakeArrayType(); | ||
|
|
||
| return _sqlExpressionFactory.AggregateFunction( | ||
| "range_agg", | ||
| new[] { sqlExpression }, | ||
| source, | ||
| nullable: true, | ||
| argumentsPropagateNullability: FalseArrays[1], | ||
| returnType: arrayClrType, | ||
| _typeMappingSource.FindMapping(arrayClrType)); | ||
|
|
||
| case nameof(NpgsqlAggregateDbFunctionsExtensions.RangeIntersectAgg): | ||
| return _sqlExpressionFactory.AggregateFunction( | ||
| "range_intersect_agg", | ||
| new[] { sqlExpression }, | ||
| source, | ||
| nullable: true, | ||
| argumentsPropagateNullability: FalseArrays[1], | ||
| returnType: sqlExpression.Type, | ||
| sqlExpression.TypeMapping); | ||
|
|
||
| case nameof(NpgsqlAggregateDbFunctionsExtensions.JsonbObjectAgg): | ||
| case nameof(NpgsqlAggregateDbFunctionsExtensions.JsonObjectAgg): | ||
| var isJsonb = method.Name == nameof(NpgsqlAggregateDbFunctionsExtensions.JsonbObjectAgg); | ||
|
|
||
| // These methods accept two enumerable (column) arguments; this is represented in LINQ as a projection from the grouping | ||
| // to a tuple of the two columns. Since we generally translate tuples to PostgresRowValueExpression, we take it apart | ||
| // here. | ||
| if (source.Selector is not PostgresRowValueExpression rowValueExpression) | ||
| { | ||
| return null; | ||
| } | ||
|
|
||
| var (keys, values) = (rowValueExpression.Values[0], rowValueExpression.Values[1]); | ||
|
|
||
| return _sqlExpressionFactory.AggregateFunction( | ||
| isJsonb ? "jsonb_object_agg" : "json_object_agg", | ||
| new[] { keys, values }, | ||
| source, | ||
| nullable: true, | ||
| argumentsPropagateNullability: FalseArrays[2], | ||
| returnType: method.ReturnType, | ||
| _typeMappingSource.FindMapping(method.ReturnType, isJsonb ? "jsonb" : "json")); | ||
| } | ||
| } | ||
|
|
||
| return null; | ||
| } | ||
| } |
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
Oops, something went wrong.