HHH-17335 Add array_set function

beikov · beikov · commit b8b8a874fdf6 · 2023-10-25T18:58:44.000+02:00
diff --git a/documentation/src/main/asciidoc/userguide/chapters/query/hql/QueryLanguage.adoc b/documentation/src/main/asciidoc/userguide/chapters/query/hql/QueryLanguage.adoc
@@ -1128,6 +1128,7 @@ The following functions deal with SQL array types, which are not supported on ev
 | `array_contains_any()` | Determines if one array holds at least one element of another array
 | `array_contains_any_nullable()` | Determines if one array holds at least one element of another array, supporting null elements
 | `array_get()` | Accesses the element of an array by index
+| `array_set()` | Creates array copy with given element at given index
 |===
 
 ===== `array()`
@@ -1260,6 +1261,19 @@ include::{array-example-dir-hql}/ArrayGetTest.java[tags=hql-array-get-example]
 ----
 ====
 
+[[hql-array-set-functions]]
+===== `array_set()`
+
+Returns an array copy with the given element placed at the given 1-based index, filling up prior slots with `null` if necessary.
+
+[[hql-array-set-example]]
+====
+[source, JAVA, indent=0]
+----
+include::{array-example-dir-hql}/ArraySetTest.java[tags=hql-array-set-example]
+----
+====
+
 [[hql-user-defined-functions]]
 ==== Native and user-defined functions
 
diff --git a/hibernate-community-dialects/src/main/java/org/hibernate/community/dialect/CockroachLegacyDialect.java b/hibernate-community-dialects/src/main/java/org/hibernate/community/dialect/CockroachLegacyDialect.java
@@ -473,6 +473,7 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio
 		functionFactory.arrayContainsAllNullable_operator();
 		functionFactory.arrayContainsAnyNullable_operator();
 		functionFactory.arrayGet_bracket();
+		functionFactory.arraySet_unnest();
 
 		functionContributions.getFunctionRegistry().register(
 				"trunc",
diff --git a/hibernate-community-dialects/src/main/java/org/hibernate/community/dialect/H2LegacyDialect.java b/hibernate-community-dialects/src/main/java/org/hibernate/community/dialect/H2LegacyDialect.java
@@ -381,6 +381,7 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio
 				functionFactory.arrayContainsAllNullable_h2();
 				functionFactory.arrayContainsAnyNullable_h2();
 				functionFactory.arrayGet_h2();
+				functionFactory.arraySet_h2();
 			}
 			else {
 				// Use group_concat until 2.x as listagg was buggy
diff --git a/hibernate-community-dialects/src/main/java/org/hibernate/community/dialect/HSQLLegacyDialect.java b/hibernate-community-dialects/src/main/java/org/hibernate/community/dialect/HSQLLegacyDialect.java
@@ -259,6 +259,7 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio
 		functionFactory.arrayContainsAllNullable_hsql();
 		functionFactory.arrayContainsAnyNullable_hsql();
 		functionFactory.arrayGet_unnest();
+		functionFactory.arraySet_hsql();
 	}
 
 	@Override
diff --git a/hibernate-community-dialects/src/main/java/org/hibernate/community/dialect/OracleLegacyDialect.java b/hibernate-community-dialects/src/main/java/org/hibernate/community/dialect/OracleLegacyDialect.java
@@ -295,6 +295,7 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio
 		functionFactory.arrayContainsAllNullable_oracle();
 		functionFactory.arrayContainsAnyNullable_oracle();
 		functionFactory.arrayGet_oracle();
+		functionFactory.arraySet_oracle();
 	}
 
 	@Override
diff --git a/hibernate-community-dialects/src/main/java/org/hibernate/community/dialect/PostgreSQLLegacyDialect.java b/hibernate-community-dialects/src/main/java/org/hibernate/community/dialect/PostgreSQLLegacyDialect.java
@@ -593,6 +593,7 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio
 		functionFactory.arrayContainsAllNullable_operator();
 		functionFactory.arrayContainsAnyNullable_operator();
 		functionFactory.arrayGet_bracket();
+		functionFactory.arraySet_unnest();
 
 		if ( getVersion().isSameOrAfter( 9, 4 ) ) {
 			functionFactory.makeDateTimeTimestamp();
diff --git a/hibernate-core/src/main/java/org/hibernate/dialect/CockroachDialect.java b/hibernate-core/src/main/java/org/hibernate/dialect/CockroachDialect.java
@@ -460,6 +460,7 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio
 		functionFactory.arrayContainsAllNullable_operator();
 		functionFactory.arrayContainsAnyNullable_operator();
 		functionFactory.arrayGet_bracket();
+		functionFactory.arraySet_unnest();
 
 		functionContributions.getFunctionRegistry().register(
 				"trunc",
diff --git a/hibernate-core/src/main/java/org/hibernate/dialect/H2Dialect.java b/hibernate-core/src/main/java/org/hibernate/dialect/H2Dialect.java
@@ -321,6 +321,7 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio
 		functionFactory.arrayContainsAllNullable_h2();
 		functionFactory.arrayContainsAnyNullable_h2();
 		functionFactory.arrayGet_h2();
+		functionFactory.arraySet_h2();
 	}
 
 	@Override
diff --git a/hibernate-core/src/main/java/org/hibernate/dialect/HSQLDialect.java b/hibernate-core/src/main/java/org/hibernate/dialect/HSQLDialect.java
@@ -199,6 +199,7 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio
 		functionFactory.arrayContainsAllNullable_hsql();
 		functionFactory.arrayContainsAnyNullable_hsql();
 		functionFactory.arrayGet_unnest();
+		functionFactory.arraySet_hsql();
 	}
 
 	@Override
diff --git a/hibernate-core/src/main/java/org/hibernate/dialect/OracleArrayJdbcType.java b/hibernate-core/src/main/java/org/hibernate/dialect/OracleArrayJdbcType.java
@@ -343,6 +343,36 @@ public void addAuxiliaryDatabaseObjects(
 						false
 				)
 		);
+		database.addAuxiliaryDatabaseObject(
+				new NamedAuxiliaryDatabaseObject(
+						arrayTypeName + "_set",
+						database.getDefaultNamespace(),
+						new String[]{
+								"create or replace function " + arrayTypeName + "_set(arr in " + arrayTypeName +
+										", idx in number, elem in " + getRawTypeName( elementType ) + ") return " + arrayTypeName + " deterministic is " +
+										"res " + arrayTypeName + ":=" + arrayTypeName + "(); begin " +
+										"if arr is not null then " +
+										"for i in 1 .. arr.count loop " +
+										"res.extend; " +
+										"res(i) := arr(i); " +
+										"end loop; " +
+										"for i in arr.count+1 .. idx loop " +
+										"res.extend; " +
+										"end loop; " +
+										"else " +
+										"for i in 1 .. idx loop " +
+										"res.extend; " +
+										"end loop; " +
+										"end if; " +
+										"res(idx) := elem; " +
+										"return res; " +
+										"end;"
+						},
+						new String[] { "drop function " + arrayTypeName + "_set" },
+						emptySet(),
+						false
+				)
+		);
 	}
 
 	protected String createOrReplaceConcatFunction(String arrayTypeName) {
diff --git a/hibernate-core/src/main/java/org/hibernate/dialect/OracleDialect.java b/hibernate-core/src/main/java/org/hibernate/dialect/OracleDialect.java
@@ -324,6 +324,7 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio
 		functionFactory.arrayContainsAllNullable_oracle();
 		functionFactory.arrayContainsAnyNullable_oracle();
 		functionFactory.arrayGet_oracle();
+		functionFactory.arraySet_oracle();
 	}
 
 	@Override
diff --git a/hibernate-core/src/main/java/org/hibernate/dialect/PostgreSQLDialect.java b/hibernate-core/src/main/java/org/hibernate/dialect/PostgreSQLDialect.java
@@ -641,6 +641,7 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio
 		functionFactory.arrayContainsAllNullable_operator();
 		functionFactory.arrayContainsAnyNullable_operator();
 		functionFactory.arrayGet_bracket();
+		functionFactory.arraySet_unnest();
 
 		functionFactory.makeDateTimeTimestamp();
 		// Note that PostgreSQL doesn't support the OVER clause for ordered set-aggregate functions
diff --git a/hibernate-core/src/main/java/org/hibernate/dialect/function/CommonFunctionFactory.java b/hibernate-core/src/main/java/org/hibernate/dialect/function/CommonFunctionFactory.java
@@ -22,15 +22,19 @@
 import org.hibernate.dialect.function.array.ArrayContainsOperatorFunction;
 import org.hibernate.dialect.function.array.ArrayContainsQuantifiedUnnestFunction;
 import org.hibernate.dialect.function.array.ArrayGetUnnestFunction;
+import org.hibernate.dialect.function.array.ArraySetUnnestFunction;
 import org.hibernate.dialect.function.array.ElementViaArrayArgumentReturnTypeResolver;
 import org.hibernate.dialect.function.array.H2ArrayContainsQuantifiedEmulation;
+import org.hibernate.dialect.function.array.H2ArraySetFunction;
 import org.hibernate.dialect.function.array.HSQLArrayPositionFunction;
+import org.hibernate.dialect.function.array.HSQLArraySetFunction;
 import org.hibernate.dialect.function.array.OracleArrayConcatFunction;
 import org.hibernate.dialect.function.array.OracleArrayContainsAllFunction;
 import org.hibernate.dialect.function.array.OracleArrayContainsAnyFunction;
 import org.hibernate.dialect.function.array.OracleArrayGetFunction;
 import org.hibernate.dialect.function.array.OracleArrayLengthFunction;
 import org.hibernate.dialect.function.array.OracleArrayPositionFunction;
+import org.hibernate.dialect.function.array.OracleArraySetFunction;
 import org.hibernate.dialect.function.array.PostgreSQLArrayConcatFunction;
 import org.hibernate.dialect.function.array.PostgreSQLArrayPositionFunction;
 import org.hibernate.dialect.function.array.CastingArrayConstructorFunction;
@@ -2976,4 +2980,32 @@ public void arrayGet_unnest() {
 	public void arrayGet_oracle() {
 		functionRegistry.register( "array_get", new OracleArrayGetFunction() );
 	}
+
+	/**
+	 * H2 array_set() function
+	 */
+	public void arraySet_h2() {
+		functionRegistry.register( "array_set", new H2ArraySetFunction() );
+	}
+
+	/**
+	 * HSQL array_set() function
+	 */
+	public void arraySet_hsql() {
+		functionRegistry.register( "array_set", new HSQLArraySetFunction() );
+	}
+
+	/**
+	 * HSQL, CockroachDB and PostgreSQL array_set() function
+	 */
+	public void arraySet_unnest() {
+		functionRegistry.register( "array_set", new ArraySetUnnestFunction() );
+	}
+
+	/**
+	 * Oracle array_set() function
+	 */
+	public void arraySet_oracle() {
+		functionRegistry.register( "array_set", new OracleArraySetFunction() );
+	}
 }
diff --git a/hibernate-core/src/main/java/org/hibernate/dialect/function/array/ArraySetUnnestFunction.java b/hibernate-core/src/main/java/org/hibernate/dialect/function/array/ArraySetUnnestFunction.java
@@ -0,0 +1,64 @@
+/*
+ * Hibernate, Relational Persistence for Idiomatic Java
+ *
+ * License: GNU Lesser General Public License (LGPL), version 2.1 or later
+ * See the lgpl.txt file in the root directory or http://www.gnu.org/licenses/lgpl-2.1.html
+ */
+package org.hibernate.dialect.function.array;
+
+import java.util.List;
+
+import org.hibernate.query.sqm.function.AbstractSqmSelfRenderingFunctionDescriptor;
+import org.hibernate.query.sqm.produce.function.ArgumentTypesValidator;
+import org.hibernate.query.sqm.produce.function.StandardArgumentsValidators;
+import org.hibernate.query.sqm.produce.function.StandardFunctionArgumentTypeResolvers;
+import org.hibernate.sql.ast.SqlAstTranslator;
+import org.hibernate.sql.ast.spi.SqlAppender;
+import org.hibernate.sql.ast.tree.SqlAstNode;
+import org.hibernate.sql.ast.tree.expression.Expression;
+
+import static org.hibernate.query.sqm.produce.function.FunctionParameterType.ANY;
+import static org.hibernate.query.sqm.produce.function.FunctionParameterType.INTEGER;
+
+/**
+ * Implement the array set function by using {@code unnest}.
+ */
+public class ArraySetUnnestFunction extends AbstractSqmSelfRenderingFunctionDescriptor {
+
+	public ArraySetUnnestFunction() {
+		super(
+				"array_set",
+				StandardArgumentsValidators.composite(
+						new ArrayAndElementArgumentValidator( 0, 2 ),
+						new ArgumentTypesValidator( null, ANY, INTEGER, ANY )
+				),
+				ArrayViaArgumentReturnTypeResolver.DEFAULT_INSTANCE,
+				StandardFunctionArgumentTypeResolvers.composite(
+						StandardFunctionArgumentTypeResolvers.IMPLIED_RESULT_TYPE,
+						StandardFunctionArgumentTypeResolvers.invariant( ANY, INTEGER, ANY ),
+						new ArrayAndElementArgumentTypeResolver( 0, 2 )
+				)
+		);
+	}
+
+	@Override
+	public void render(
+			SqlAppender sqlAppender,
+			List<? extends SqlAstNode> sqlAstArguments,
+			SqlAstTranslator<?> walker) {
+		final Expression arrayExpression = (Expression) sqlAstArguments.get( 0 );
+		final Expression indexExpression = (Expression) sqlAstArguments.get( 1 );
+		final Expression elementExpression = (Expression) sqlAstArguments.get( 2 );
+		sqlAppender.append( "(select array_agg(case when i.idx=");
+		indexExpression.accept( walker );
+		sqlAppender.append(" then " );
+		elementExpression.accept( walker );
+		sqlAppender.append(" else t.val end) from generate_series(1,greatest(coalesce(cardinality(" );
+		arrayExpression.accept( walker );
+		sqlAppender.append( "),0)," );
+		indexExpression.accept( walker );
+		sqlAppender.append( ")) i(idx) left join unnest(" );
+		arrayExpression.accept( walker );
+		sqlAppender.append( ") with ordinality t(val, idx) on i.idx=t.idx)" );
+	}
+}
diff --git a/hibernate-core/src/main/java/org/hibernate/dialect/function/array/ArrayViaArgumentReturnTypeResolver.java b/hibernate-core/src/main/java/org/hibernate/dialect/function/array/ArrayViaArgumentReturnTypeResolver.java
@@ -0,0 +1,70 @@
+/*
+ * Hibernate, Relational Persistence for Idiomatic Java
+ *
+ * License: GNU Lesser General Public License (LGPL), version 2.1 or later.
+ * See the lgpl.txt file in the root directory or <http://www.gnu.org/licenses/lgpl-2.1.html>.
+ */
+package org.hibernate.dialect.function.array;
+
+import java.util.List;
+import java.util.function.Supplier;
+
+import org.hibernate.metamodel.mapping.BasicValuedMapping;
+import org.hibernate.metamodel.mapping.MappingModelExpressible;
+import org.hibernate.metamodel.model.domain.DomainType;
+import org.hibernate.query.ReturnableType;
+import org.hibernate.query.sqm.SqmExpressible;
+import org.hibernate.query.sqm.produce.function.FunctionReturnTypeResolver;
+import org.hibernate.query.sqm.tree.SqmTypedNode;
+import org.hibernate.sql.ast.tree.SqlAstNode;
+import org.hibernate.type.BasicPluralType;
+import org.hibernate.type.spi.TypeConfiguration;
+
+/**
+ * A {@link FunctionReturnTypeResolver} that resolves the array type based on an argument.
+ * The inferred type and implied type have precedence though.
+ */
+public class ArrayViaArgumentReturnTypeResolver implements FunctionReturnTypeResolver {
+
+	public static final FunctionReturnTypeResolver DEFAULT_INSTANCE = new ArrayViaArgumentReturnTypeResolver( 0 );
+
+	private final int arrayIndex;
+
+	private ArrayViaArgumentReturnTypeResolver(int arrayIndex) {
+		this.arrayIndex = arrayIndex;
+	}
+
+	@Override
+	public ReturnableType<?> resolveFunctionReturnType(
+			ReturnableType<?> impliedType,
+			Supplier<MappingModelExpressible<?>> inferredTypeSupplier,
+			List<? extends SqmTypedNode<?>> arguments,
+			TypeConfiguration typeConfiguration) {
+		final MappingModelExpressible<?> inferredType = inferredTypeSupplier.get();
+		if ( inferredType != null ) {
+			if ( inferredType instanceof ReturnableType<?> ) {
+				return (ReturnableType<?>) inferredType;
+			}
+			else if ( inferredType instanceof BasicValuedMapping ) {
+				return (ReturnableType<?>) ( (BasicValuedMapping) inferredType ).getJdbcMapping();
+			}
+		}
+		if ( impliedType != null ) {
+			return impliedType;
+		}
+		final SqmExpressible<?> expressible = arguments.get( arrayIndex ).getExpressible();
+		final DomainType<?> type;
+		if ( expressible != null && ( type = expressible.getSqmType() ) instanceof BasicPluralType<?, ?> ) {
+			return (ReturnableType<?>) type;
+		}
+		return null;
+	}
+
+	@Override
+	public BasicValuedMapping resolveFunctionReturnType(
+			Supplier<BasicValuedMapping> impliedTypeAccess,
+			List<? extends SqlAstNode> arguments) {
+		return null;
+	}
+
+}
diff --git a/hibernate-core/src/main/java/org/hibernate/dialect/function/array/H2ArraySetFunction.java b/hibernate-core/src/main/java/org/hibernate/dialect/function/array/H2ArraySetFunction.java
@@ -0,0 +1,57 @@
+/*
+ * Hibernate, Relational Persistence for Idiomatic Java
+ *
+ * License: GNU Lesser General Public License (LGPL), version 2.1 or later
+ * See the lgpl.txt file in the root directory or http://www.gnu.org/licenses/lgpl-2.1.html
+ */
+package org.hibernate.dialect.function.array;
+
+import java.util.List;
+
+import org.hibernate.metamodel.mapping.JdbcMappingContainer;
+import org.hibernate.sql.ast.SqlAstTranslator;
+import org.hibernate.sql.ast.spi.SqlAppender;
+import org.hibernate.sql.ast.tree.SqlAstNode;
+import org.hibernate.sql.ast.tree.expression.Expression;
+
+/**
+ * H2 array_set function.
+ */
+public class H2ArraySetFunction extends ArraySetUnnestFunction {
+
+	public H2ArraySetFunction() {
+	}
+
+	@Override
+	public void render(
+			SqlAppender sqlAppender,
+			List<? extends SqlAstNode> sqlAstArguments,
+			SqlAstTranslator<?> walker) {
+		final Expression arrayExpression = (Expression) sqlAstArguments.get( 0 );
+		final Expression indexExpression = (Expression) sqlAstArguments.get( 1 );
+		final Expression elementExpression = (Expression) sqlAstArguments.get( 2 );
+		sqlAppender.append( "(select array_agg(case when i.idx=");
+		indexExpression.accept( walker );
+		sqlAppender.append(" then " );
+		elementExpression.accept( walker );
+		sqlAppender.append(" when " );
+		arrayExpression.accept( walker );
+		sqlAppender.append(" is not null and i.idx<=cardinality(");
+		arrayExpression.accept( walker );
+		sqlAppender.append(") then array_get(");
+		arrayExpression.accept( walker );
+		sqlAppender.append(",i.idx) end) from system_range(1," );
+		sqlAppender.append( Integer.toString( getMaximumArraySize() ) );
+		sqlAppender.append( ") i(idx) where i.idx<=greatest(case when ");
+		arrayExpression.accept( walker );
+		sqlAppender.append(" is not null then cardinality(" );
+		arrayExpression.accept( walker );
+		sqlAppender.append( ") else 0 end," );
+		indexExpression.accept( walker );
+		sqlAppender.append( "))" );
+	}
+
+	protected int getMaximumArraySize() {
+		return 1000;
+	}
+}
diff --git a/hibernate-core/src/main/java/org/hibernate/dialect/function/array/HSQLArraySetFunction.java b/hibernate-core/src/main/java/org/hibernate/dialect/function/array/HSQLArraySetFunction.java
diff --git a/hibernate-core/src/main/java/org/hibernate/dialect/function/array/OracleArraySetFunction.java b/hibernate-core/src/main/java/org/hibernate/dialect/function/array/OracleArraySetFunction.java
diff --git a/hibernate-core/src/test/java/org/hibernate/orm/test/function/array/ArraySetTest.java b/hibernate-core/src/test/java/org/hibernate/orm/test/function/array/ArraySetTest.java

Original file line number	Diff line number	Diff line change
`@@ -381,6 +381,7 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio`
`381`	`381`	`functionFactory.arrayContainsAllNullable_h2();`
`382`	`382`	`functionFactory.arrayContainsAnyNullable_h2();`
`383`	`383`	`functionFactory.arrayGet_h2();`
	`384`	`+ functionFactory.arraySet_h2();`
`384`	`385`	`}`
`385`	`386`	`else {`
`386`	`387`	`// Use group_concat until 2.x as listagg was buggy`
Original file line number	Diff line number	Diff line change
`@@ -259,6 +259,7 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio`
`259`	`259`	`functionFactory.arrayContainsAllNullable_hsql();`
`260`	`260`	`functionFactory.arrayContainsAnyNullable_hsql();`
`261`	`261`	`functionFactory.arrayGet_unnest();`
	`262`	`+ functionFactory.arraySet_hsql();`
`262`	`263`	`}`
`263`	`264`
`264`	`265`	`@Override`
Original file line number	Diff line number	Diff line change
`@@ -295,6 +295,7 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio`
`295`	`295`	`functionFactory.arrayContainsAllNullable_oracle();`
`296`	`296`	`functionFactory.arrayContainsAnyNullable_oracle();`
`297`	`297`	`functionFactory.arrayGet_oracle();`
	`298`	`+ functionFactory.arraySet_oracle();`
`298`	`299`	`}`
`299`	`300`
`300`	`301`	`@Override`
Original file line number	Diff line number	Diff line change
`@@ -321,6 +321,7 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio`
`321`	`321`	`functionFactory.arrayContainsAllNullable_h2();`
`322`	`322`	`functionFactory.arrayContainsAnyNullable_h2();`
`323`	`323`	`functionFactory.arrayGet_h2();`
	`324`	`+ functionFactory.arraySet_h2();`
`324`	`325`	`}`
`325`	`326`
`326`	`327`	`@Override`
Original file line number	Diff line number	Diff line change
`@@ -199,6 +199,7 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio`
`199`	`199`	`functionFactory.arrayContainsAllNullable_hsql();`
`200`	`200`	`functionFactory.arrayContainsAnyNullable_hsql();`
`201`	`201`	`functionFactory.arrayGet_unnest();`
	`202`	`+ functionFactory.arraySet_hsql();`
`202`	`203`	`}`
`203`	`204`
`204`	`205`	`@Override`