HHH-17335 Add array_remove function

beikov · beikov · commit 865365e6ec74 · 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
@@ -1129,6 +1129,7 @@ The following functions deal with SQL array types, which are not supported on ev
 | `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_remove()` | Creates array copy with given element removed
 |===
 
 ===== `array()`
@@ -1274,6 +1275,19 @@ include::{array-example-dir-hql}/ArraySetTest.java[tags=hql-array-set-example]
 ----
 ====
 
+[[hql-array-remove-functions]]
+===== `array_remove()`
+
+Returns an array copy with the given element removed from the array. Allows removal of `null` elements.
+
+[[hql-array-remove-example]]
+====
+[source, JAVA, indent=0]
+----
+include::{array-example-dir-hql}/ArrayRemoveTest.java[tags=hql-array-remove-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,6 +474,7 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio
 		functionFactory.arrayContainsAnyNullable_operator();
 		functionFactory.arrayGet_bracket();
 		functionFactory.arraySet_unnest();
+		functionFactory.arrayRemove_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
@@ -382,6 +382,7 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio
 				functionFactory.arrayContainsAnyNullable_h2();
 				functionFactory.arrayGet_h2();
 				functionFactory.arraySet_h2();
+				functionFactory.arrayRemove_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
@@ -260,6 +260,7 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio
 		functionFactory.arrayContainsAnyNullable_hsql();
 		functionFactory.arrayGet_unnest();
 		functionFactory.arraySet_hsql();
+		functionFactory.arrayRemove_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
@@ -296,6 +296,7 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio
 		functionFactory.arrayContainsAnyNullable_oracle();
 		functionFactory.arrayGet_oracle();
 		functionFactory.arraySet_oracle();
+		functionFactory.arrayRemove_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,6 +594,7 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio
 		functionFactory.arrayContainsAnyNullable_operator();
 		functionFactory.arrayGet_bracket();
 		functionFactory.arraySet_unnest();
+		functionFactory.arrayRemove_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
@@ -461,6 +461,7 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio
 		functionFactory.arrayContainsAnyNullable_operator();
 		functionFactory.arrayGet_bracket();
 		functionFactory.arraySet_unnest();
+		functionFactory.arrayRemove_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
@@ -322,6 +322,7 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio
 		functionFactory.arrayContainsAnyNullable_h2();
 		functionFactory.arrayGet_h2();
 		functionFactory.arraySet_h2();
+		functionFactory.arrayRemove_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
@@ -200,6 +200,7 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio
 		functionFactory.arrayContainsAnyNullable_hsql();
 		functionFactory.arrayGet_unnest();
 		functionFactory.arraySet_hsql();
+		functionFactory.arrayRemove_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
@@ -373,6 +373,32 @@ public void addAuxiliaryDatabaseObjects(
 						false
 				)
 		);
+		database.addAuxiliaryDatabaseObject(
+				new NamedAuxiliaryDatabaseObject(
+						arrayTypeName + "_remove",
+						database.getDefaultNamespace(),
+						new String[]{
+								"create or replace function " + arrayTypeName + "_remove(arr in " + arrayTypeName +
+										", elem in " + getRawTypeName( elementType ) + ") return " + arrayTypeName + " deterministic is " +
+										"res " + arrayTypeName + ":=" + arrayTypeName + "(); begin " +
+										"if arr is null then return null; end if; " +
+										"if elem is null then " +
+										"for i in 1 .. arr.count loop " +
+										"if arr(i) is not null then res.extend; res(res.last) := arr(i); end if; " +
+										"end loop; " +
+										"else " +
+										"for i in 1 .. arr.count loop " +
+										"if arr(i) is null or arr(i)<>elem then res.extend; res(res.last) := arr(i); end if; " +
+										"end loop; " +
+										"end if; " +
+										"return res; " +
+										"end;"
+						},
+						new String[] { "drop function " + arrayTypeName + "_remove" },
+						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
@@ -325,6 +325,7 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio
 		functionFactory.arrayContainsAnyNullable_oracle();
 		functionFactory.arrayGet_oracle();
 		functionFactory.arraySet_oracle();
+		functionFactory.arrayRemove_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,6 +642,7 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio
 		functionFactory.arrayContainsAnyNullable_operator();
 		functionFactory.arrayGet_bracket();
 		functionFactory.arraySet_unnest();
+		functionFactory.arrayRemove_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
@@ -23,17 +23,21 @@
 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.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.H2ArraySetFunction;
 import org.hibernate.dialect.function.array.HSQLArrayPositionFunction;
+import org.hibernate.dialect.function.array.HSQLArrayRemoveFunction;
 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.OracleArrayRemoveFunction;
 import org.hibernate.dialect.function.array.OracleArraySetFunction;
 import org.hibernate.dialect.function.array.PostgreSQLArrayConcatFunction;
 import org.hibernate.dialect.function.array.PostgreSQLArrayPositionFunction;
@@ -2996,7 +3000,7 @@ public void arraySet_hsql() {
 	}
 
 	/**
-	 * HSQL, CockroachDB and PostgreSQL array_set() function
+	 * CockroachDB and PostgreSQL array_set() function
 	 */
 	public void arraySet_unnest() {
 		functionRegistry.register( "array_set", new ArraySetUnnestFunction() );
@@ -3008,4 +3012,41 @@ public void arraySet_unnest() {
 	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() {
+		functionRegistry.namedDescriptorBuilder( "array_remove" )
+				.setArgumentsValidator(
+						StandardArgumentsValidators.composite(
+								StandardArgumentsValidators.exactly( 2 ),
+								ArrayAndElementArgumentValidator.DEFAULT_INSTANCE
+						)
+				)
+				.setReturnTypeResolver( ArrayViaArgumentReturnTypeResolver.DEFAULT_INSTANCE )
+				.setArgumentTypeResolver( ArrayAndElementArgumentTypeResolver.DEFAULT_INSTANCE )
+				.register();
+	}
+
+	/**
+	 * Oracle array_remove() function
+	 */
+	public void arrayRemove_oracle() {
+		functionRegistry.register( "array_remove", new OracleArrayRemoveFunction() );
+	}
 }
diff --git a/hibernate-core/src/main/java/org/hibernate/dialect/function/array/AbstractArrayRemoveFunction.java b/hibernate-core/src/main/java/org/hibernate/dialect/function/array/AbstractArrayRemoveFunction.java
@@ -0,0 +1,29 @@
+/*
+ * 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 org.hibernate.query.sqm.function.AbstractSqmSelfRenderingFunctionDescriptor;
+import org.hibernate.query.sqm.produce.function.StandardArgumentsValidators;
+
+/**
+ * Encapsulates the validator, return type and argument type resolvers for the array_remove functions.
+ * Subclasses only have to implement the rendering.
+ */
+public abstract class AbstractArrayRemoveFunction extends AbstractSqmSelfRenderingFunctionDescriptor {
+
+	public AbstractArrayRemoveFunction() {
+		super(
+				"array_remove",
+				StandardArgumentsValidators.composite(
+						StandardArgumentsValidators.exactly( 2 ),
+						ArrayAndElementArgumentValidator.DEFAULT_INSTANCE
+				),
+				ArrayViaArgumentReturnTypeResolver.DEFAULT_INSTANCE,
+				ArrayAndElementArgumentTypeResolver.DEFAULT_INSTANCE
+		);
+	}
+}
diff --git a/hibernate-core/src/main/java/org/hibernate/dialect/function/array/H2ArrayRemoveFunction.java b/hibernate-core/src/main/java/org/hibernate/dialect/function/array/H2ArrayRemoveFunction.java
@@ -0,0 +1,49 @@
+/*
+ * 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 function.
+ */
+public class H2ArrayRemoveFunction extends AbstractArrayRemoveFunction {
+
+	public H2ArrayRemoveFunction() {
+	}
+
+	@Override
+	public void render(
+			SqlAppender sqlAppender,
+			List<? extends SqlAstNode> sqlAstArguments,
+			SqlAstTranslator<?> walker) {
+		final Expression arrayExpression = (Expression) sqlAstArguments.get( 0 );
+		final Expression elementExpression = (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 array_get(");
+		arrayExpression.accept( walker );
+		sqlAppender.append( ",i.idx) is distinct from " );
+		elementExpression.accept( walker );
+		sqlAppender.append( "),array[]) end" );
+	}
+
+	protected int getMaximumArraySize() {
+		return 1000;
+	}
+}
diff --git a/hibernate-core/src/main/java/org/hibernate/dialect/function/array/HSQLArrayRemoveFunction.java b/hibernate-core/src/main/java/org/hibernate/dialect/function/array/HSQLArrayRemoveFunction.java
@@ -0,0 +1,39 @@
+/*
+ * 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;
+
+/**
+ * HSQLDB array_remove function.
+ */
+public class HSQLArrayRemoveFunction extends AbstractArrayRemoveFunction {
+
+	public HSQLArrayRemoveFunction() {
+	}
+
+	@Override
+	public void render(
+			SqlAppender sqlAppender,
+			List<? extends SqlAstNode> sqlAstArguments,
+			SqlAstTranslator<?> walker) {
+		final Expression arrayExpression = (Expression) sqlAstArguments.get( 0 );
+		final Expression elementExpression = (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.val is distinct from " );
+		elementExpression.accept( walker );
+		sqlAppender.append( "),array[]) end" );
+	}
+}
diff --git a/hibernate-core/src/main/java/org/hibernate/dialect/function/array/OracleArrayGetFunction.java b/hibernate-core/src/main/java/org/hibernate/dialect/function/array/OracleArrayGetFunction.java
@@ -8,7 +8,6 @@
 
 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;
@@ -27,15 +26,10 @@ public void render(
 			SqlAppender sqlAppender,
 			List<? extends SqlAstNode> sqlAstArguments,
 			SqlAstTranslator<?> walker) {
-		JdbcMappingContainer expressionType = null;
-		for ( SqlAstNode sqlAstArgument : sqlAstArguments ) {
-			expressionType = ( (Expression) sqlAstArgument ).getExpressionType();
-			if ( expressionType != null ) {
-				break;
-			}
-		}
-
-		final String arrayTypeName = ArrayTypeHelper.getArrayTypeName( expressionType, walker );
+		final String arrayTypeName = ArrayTypeHelper.getArrayTypeName(
+				( (Expression) sqlAstArguments.get( 0 ) ).getExpressionType(),
+				walker
+		);
 		sqlAppender.append( arrayTypeName );
 		sqlAppender.append( "_get(" );
 		sqlAstArguments.get( 0 ).accept( walker );
diff --git a/hibernate-core/src/main/java/org/hibernate/dialect/function/array/OracleArrayRemoveFunction.java b/hibernate-core/src/main/java/org/hibernate/dialect/function/array/OracleArrayRemoveFunction.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/ArrayRemoveTest.java b/hibernate-core/src/test/java/org/hibernate/orm/test/function/array/ArrayRemoveTest.java

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