HHH-17335 Add array_remove_index function

beikov · beikov · commit 950423e7dd81 · 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
@@ -1288,6 +1288,19 @@ include::{array-example-dir-hql}/ArrayRemoveTest.java[tags=hql-array-remove-exam
 ----
 ====
 
+[[hql-array-remove-index-functions]]
+===== `array_remove_index()`
+
+Returns an array copy with the element at the given index removed from the array.
+
+[[hql-array-remove-index-example]]
+====
+[source, JAVA, indent=0]
+----
+include::{array-example-dir-hql}/ArrayRemoveIndexTest.java[tags=hql-array-remove-index-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
@@ -474,7 +474,8 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio
 		functionFactory.arrayContainsAnyNullable_operator();
 		functionFactory.arrayGet_bracket();
 		functionFactory.arraySet_unnest();
-		functionFactory.arrayRemove_unnest();
+		functionFactory.arrayRemove();
+		functionFactory.arrayRemoveIndex_postgresql();
 
 		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
@@ -383,6 +383,7 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio
 				functionFactory.arrayGet_h2();
 				functionFactory.arraySet_h2();
 				functionFactory.arrayRemove_h2();
+				functionFactory.arrayRemoveIndex_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
@@ -261,6 +261,7 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio
 		functionFactory.arrayGet_unnest();
 		functionFactory.arraySet_hsql();
 		functionFactory.arrayRemove_hsql();
+		functionFactory.arrayRemoveIndex_unnest();
 	}
 
 	@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
@@ -297,6 +297,7 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio
 		functionFactory.arrayGet_oracle();
 		functionFactory.arraySet_oracle();
 		functionFactory.arrayRemove_oracle();
+		functionFactory.arrayRemoveIndex_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
@@ -594,7 +594,8 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio
 		functionFactory.arrayContainsAnyNullable_operator();
 		functionFactory.arrayGet_bracket();
 		functionFactory.arraySet_unnest();
-		functionFactory.arrayRemove_unnest();
+		functionFactory.arrayRemove();
+		functionFactory.arrayRemoveIndex_postgresql();
 
 		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
@@ -461,7 +461,8 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio
 		functionFactory.arrayContainsAnyNullable_operator();
 		functionFactory.arrayGet_bracket();
 		functionFactory.arraySet_unnest();
-		functionFactory.arrayRemove_unnest();
+		functionFactory.arrayRemove();
+		functionFactory.arrayRemoveIndex_postgresql();
 
 		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
@@ -323,6 +323,7 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio
 		functionFactory.arrayGet_h2();
 		functionFactory.arraySet_h2();
 		functionFactory.arrayRemove_h2();
+		functionFactory.arrayRemoveIndex_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
@@ -201,6 +201,7 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio
 		functionFactory.arrayGet_unnest();
 		functionFactory.arraySet_hsql();
 		functionFactory.arrayRemove_hsql();
+		functionFactory.arrayRemoveIndex_unnest();
 	}
 
 	@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
@@ -399,6 +399,26 @@ public void addAuxiliaryDatabaseObjects(
 						false
 				)
 		);
+		database.addAuxiliaryDatabaseObject(
+				new NamedAuxiliaryDatabaseObject(
+						arrayTypeName + "_remove_index",
+						database.getDefaultNamespace(),
+						new String[]{
+								"create or replace function " + arrayTypeName + "_remove_index(arr in " + arrayTypeName +
+										", idx in number) return " + arrayTypeName + " deterministic is " +
+										"res " + arrayTypeName + ":=" + arrayTypeName + "(); begin " +
+										"if arr is null or idx is null then return arr; end if; " +
+										"for i in 1 .. arr.count loop " +
+										"if i<>idx then res.extend; res(res.last) := arr(i); end if; " +
+										"end loop; " +
+										"return res; " +
+										"end;"
+						},
+						new String[] { "drop function " + arrayTypeName + "_remove_index" },
+						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
@@ -326,6 +326,7 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio
 		functionFactory.arrayGet_oracle();
 		functionFactory.arraySet_oracle();
 		functionFactory.arrayRemove_oracle();
+		functionFactory.arrayRemoveIndex_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
@@ -642,7 +642,8 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio
 		functionFactory.arrayContainsAnyNullable_operator();
 		functionFactory.arrayGet_bracket();
 		functionFactory.arraySet_unnest();
-		functionFactory.arrayRemove_unnest();
+		functionFactory.arrayRemove();
+		functionFactory.arrayRemoveIndex_postgresql();
 
 		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,11 +22,13 @@
 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.ArrayRemoveIndexUnnestFunction;
 import org.hibernate.dialect.function.array.ArraySetUnnestFunction;
 import org.hibernate.dialect.function.array.ArrayViaArgumentReturnTypeResolver;
 import org.hibernate.dialect.function.array.ElementViaArrayArgumentReturnTypeResolver;
 import org.hibernate.dialect.function.array.H2ArrayContainsQuantifiedEmulation;
 import org.hibernate.dialect.function.array.H2ArrayRemoveFunction;
+import org.hibernate.dialect.function.array.H2ArrayRemoveIndexFunction;
 import org.hibernate.dialect.function.array.H2ArraySetFunction;
 import org.hibernate.dialect.function.array.HSQLArrayPositionFunction;
 import org.hibernate.dialect.function.array.HSQLArrayRemoveFunction;
@@ -38,6 +40,7 @@
 import org.hibernate.dialect.function.array.OracleArrayLengthFunction;
 import org.hibernate.dialect.function.array.OracleArrayPositionFunction;
 import org.hibernate.dialect.function.array.OracleArrayRemoveFunction;
+import org.hibernate.dialect.function.array.OracleArrayRemoveIndexFunction;
 import org.hibernate.dialect.function.array.OracleArraySetFunction;
 import org.hibernate.dialect.function.array.PostgreSQLArrayConcatFunction;
 import org.hibernate.dialect.function.array.PostgreSQLArrayPositionFunction;
@@ -3013,24 +3016,10 @@ public void arraySet_oracle() {
 		functionRegistry.register( "array_set", new OracleArraySetFunction() );
 	}
 
-	/**
-	 * H2 array_remove() function
-	 */
-	public void arrayRemove_h2() {
-		functionRegistry.register( "array_remove", new H2ArrayRemoveFunction() );
-	}
-
-	/**
-	 * HSQL array_remove() function
-	 */
-	public void arrayRemove_hsql() {
-		functionRegistry.register( "array_remove", new HSQLArrayRemoveFunction() );
-	}
-
 	/**
 	 * CockroachDB and PostgreSQL array_remove() function
 	 */
-	public void arrayRemove_unnest() {
+	public void arrayRemove() {
 		functionRegistry.namedDescriptorBuilder( "array_remove" )
 				.setArgumentsValidator(
 						StandardArgumentsValidators.composite(
@@ -3043,10 +3032,52 @@ public void arrayRemove_unnest() {
 				.register();
 	}
 
+	/**
+	 * H2 array_remove() function
+	 */
+	public void arrayRemove_h2() {
+		functionRegistry.register( "array_remove", new H2ArrayRemoveFunction() );
+	}
+
+	/**
+	 * HSQL array_remove() function
+	 */
+	public void arrayRemove_hsql() {
+		functionRegistry.register( "array_remove", new HSQLArrayRemoveFunction() );
+	}
+
 	/**
 	 * Oracle array_remove() function
 	 */
 	public void arrayRemove_oracle() {
 		functionRegistry.register( "array_remove", new OracleArrayRemoveFunction() );
 	}
+
+	/**
+	 * H2 array_remove_index() function
+	 */
+	public void arrayRemoveIndex_h2() {
+		functionRegistry.register( "array_remove_index", new H2ArrayRemoveIndexFunction() );
+	}
+
+	/**
+	 * HSQL, CockroachDB and PostgreSQL array_remove_index() function
+	 */
+	public void arrayRemoveIndex_unnest() {
+		functionRegistry.register( "array_remove_index", new ArrayRemoveIndexUnnestFunction( false ) );
+	}
+
+	/**
+	 * HSQL, CockroachDB and PostgreSQL array_remove_index() function
+	 */
+	public void arrayRemoveIndex_postgresql() {
+		functionRegistry.register( "array_remove_index", new ArrayRemoveIndexUnnestFunction( true ) );
+	}
+
+	/**
+	 * Oracle array_remove_index() function
+	 */
+	public void arrayRemoveIndex_oracle() {
+		functionRegistry.register( "array_remove_index", new OracleArrayRemoveIndexFunction() );
+	}
 }
diff --git a/hibernate-core/src/main/java/org/hibernate/dialect/function/array/ArrayRemoveIndexUnnestFunction.java b/hibernate-core/src/main/java/org/hibernate/dialect/function/array/ArrayRemoveIndexUnnestFunction.java
@@ -0,0 +1,71 @@
+/*
+ * 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;
+
+/**
+ * Encapsulates the validator, return type and argument type resolvers for the array_remove_index functions.
+ * Subclasses only have to implement the rendering.
+ */
+public class ArrayRemoveIndexUnnestFunction extends AbstractSqmSelfRenderingFunctionDescriptor {
+
+	private final boolean castEmptyArrayLiteral;
+
+	public ArrayRemoveIndexUnnestFunction(boolean castEmptyArrayLiteral) {
+		super(
+				"array_remove_index",
+				StandardArgumentsValidators.composite(
+						new ArgumentTypesValidator( null, ANY, INTEGER ),
+						ArrayArgumentValidator.DEFAULT_INSTANCE
+				),
+				ArrayViaArgumentReturnTypeResolver.DEFAULT_INSTANCE,
+				StandardFunctionArgumentTypeResolvers.composite(
+						StandardFunctionArgumentTypeResolvers.invariant( ANY, INTEGER ),
+						StandardFunctionArgumentTypeResolvers.IMPLIED_RESULT_TYPE
+				)
+		);
+		this.castEmptyArrayLiteral = castEmptyArrayLiteral;
+	}
+
+	@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 );
+		sqlAppender.append( "case when ");
+		arrayExpression.accept( walker );
+		sqlAppender.append( " is null then null else coalesce((select array_agg(t.val) from unnest(" );
+		arrayExpression.accept( walker );
+		sqlAppender.append( ") with ordinality t(val,idx) where t.idx is distinct from " );
+		indexExpression.accept( walker );
+		sqlAppender.append( "),");
+		if ( castEmptyArrayLiteral ) {
+			sqlAppender.append( "cast(array[] as " );
+			sqlAppender.append( ArrayTypeHelper.getArrayTypeName( arrayExpression.getExpressionType(), walker ) );
+			sqlAppender.append( ')' );
+		}
+		else {
+			sqlAppender.append( "array[]" );
+		}
+		sqlAppender.append(") end" );
+	}
+}
diff --git a/hibernate-core/src/main/java/org/hibernate/dialect/function/array/H2ArrayRemoveIndexFunction.java b/hibernate-core/src/main/java/org/hibernate/dialect/function/array/H2ArrayRemoveIndexFunction.java
@@ -0,0 +1,48 @@
+/*
+ * 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.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_remove_index function.
+ */
+public class H2ArrayRemoveIndexFunction extends ArrayRemoveIndexUnnestFunction {
+
+	public H2ArrayRemoveIndexFunction() {
+		super( false );
+	}
+
+	@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 );
+		sqlAppender.append( "case when ");
+		arrayExpression.accept( walker );
+		sqlAppender.append( " is null then null else coalesce((select array_agg(array_get(");
+		arrayExpression.accept( walker );
+		sqlAppender.append(",i.idx)) from system_range(1," );
+		sqlAppender.append( Integer.toString( getMaximumArraySize() ) );
+		sqlAppender.append( ") i(idx) where i.idx<=coalesce(cardinality(");
+		arrayExpression.accept( walker );
+		sqlAppender.append("),0) and i.idx is distinct from " );
+		indexExpression.accept( walker );
+		sqlAppender.append( "),array[]) end" );
+	}
+
+	protected int getMaximumArraySize() {
+		return 1000;
+	}
+}
diff --git a/hibernate-core/src/main/java/org/hibernate/dialect/function/array/OracleArrayRemoveIndexFunction.java b/hibernate-core/src/main/java/org/hibernate/dialect/function/array/OracleArrayRemoveIndexFunction.java
@@ -0,0 +1,41 @@
+/*
+ * 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.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;
+
+/**
+ * Oracle array_remove_index function.
+ */
+public class OracleArrayRemoveIndexFunction extends ArrayRemoveIndexUnnestFunction {
+
+	public OracleArrayRemoveIndexFunction() {
+		super( false );
+	}
+
+	@Override
+	public void render(
+			SqlAppender sqlAppender,
+			List<? extends SqlAstNode> sqlAstArguments,
+			SqlAstTranslator<?> walker) {
+		final String arrayTypeName = ArrayTypeHelper.getArrayTypeName(
+				( (Expression) sqlAstArguments.get( 0 ) ).getExpressionType(),
+				walker
+		);
+		sqlAppender.append( arrayTypeName );
+		sqlAppender.append( "_remove_index(" );
+		sqlAstArguments.get( 0 ).accept( walker );
+		sqlAppender.append( ',' );
+		sqlAstArguments.get( 1 ).accept( walker );
+		sqlAppender.append( ')' );
+	}
+}
diff --git a/hibernate-core/src/test/java/org/hibernate/orm/test/function/array/ArrayRemoveIndexTest.java b/hibernate-core/src/test/java/org/hibernate/orm/test/function/array/ArrayRemoveIndexTest.java

Original file line number	Diff line number	Diff line change
`@@ -383,6 +383,7 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio`
`383`	`383`	`functionFactory.arrayGet_h2();`
`384`	`384`	`functionFactory.arraySet_h2();`
`385`	`385`	`functionFactory.arrayRemove_h2();`
	`386`	`+ functionFactory.arrayRemoveIndex_h2();`
`386`	`387`	`}`
`387`	`388`	`else {`
`388`	`389`	`// Use group_concat until 2.x as listagg was buggy`
Original file line number	Diff line number	Diff line change
`@@ -261,6 +261,7 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio`
`261`	`261`	`functionFactory.arrayGet_unnest();`
`262`	`262`	`functionFactory.arraySet_hsql();`
`263`	`263`	`functionFactory.arrayRemove_hsql();`
	`264`	`+ functionFactory.arrayRemoveIndex_unnest();`
`264`	`265`	`}`
`265`	`266`
`266`	`267`	`@Override`
Original file line number	Diff line number	Diff line change
`@@ -297,6 +297,7 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio`
`297`	`297`	`functionFactory.arrayGet_oracle();`
`298`	`298`	`functionFactory.arraySet_oracle();`
`299`	`299`	`functionFactory.arrayRemove_oracle();`
	`300`	`+ functionFactory.arrayRemoveIndex_oracle();`
`300`	`301`	`}`
`301`	`302`
`302`	`303`	`@Override`
Original file line number	Diff line number	Diff line change
`@@ -323,6 +323,7 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio`
`323`	`323`	`functionFactory.arrayGet_h2();`
`324`	`324`	`functionFactory.arraySet_h2();`
`325`	`325`	`functionFactory.arrayRemove_h2();`
	`326`	`+ functionFactory.arrayRemoveIndex_h2();`
`326`	`327`	`}`
`327`	`328`
`328`	`329`	`@Override`
Original file line number	Diff line number	Diff line change
`@@ -201,6 +201,7 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio`
`201`	`201`	`functionFactory.arrayGet_unnest();`
`202`	`202`	`functionFactory.arraySet_hsql();`
`203`	`203`	`functionFactory.arrayRemove_hsql();`
	`204`	`+ functionFactory.arrayRemoveIndex_unnest();`
`204`	`205`	`}`
`205`	`206`
`206`	`207`	`@Override`