HHH-17335 Add array_concat function

beikov · beikov · commit d46fcf1abefa · 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
@@ -1122,6 +1122,7 @@ The following functions deal with SQL array types, which are not supported on ev
 | `array_contains_null()` | Whether an array contains a null
 | `array_position()` | Determines the position of an element in an array
 | `array_length()` | Determines the length of an array
+| `array_concat()` | Concatenates array with each other in order
 |===
 
 ===== `array()`
@@ -1181,6 +1182,19 @@ include::{array-example-dir-hql}/ArrayLengthTest.java[tags=hql-array-length-exam
 ----
 ====
 
+[[hql-array-concat-functions]]
+===== `array_concat()`
+
+Concatenates arrays with each other in order. Returns `null` if one of the arguments is `null`.
+
+[[hql-array-concat-example]]
+====
+[source, JAVA, indent=0]
+----
+include::{array-example-dir-hql}/ArrayConcatTest.java[tags=hql-array-concat-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
@@ -467,6 +467,7 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio
 		functionFactory.arrayContainsNull_array_position();
 		functionFactory.arrayPosition_postgresql();
 		functionFactory.arrayLength_cardinality();
+		functionFactory.arrayConcat_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
@@ -375,6 +375,7 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio
 				functionFactory.arrayContains();
 				functionFactory.arrayContainsNull();
 				functionFactory.arrayLength_cardinality();
+				functionFactory.arrayConcat_operator();
 			}
 			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
@@ -253,6 +253,7 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio
 		functionFactory.arrayContainsNull_hsql();
 		functionFactory.arrayPosition_hsql();
 		functionFactory.arrayLength_cardinality();
+		functionFactory.arrayConcat_operator();
 	}
 
 	@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
@@ -289,6 +289,7 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio
 		functionFactory.arrayContainsNull_oracle();
 		functionFactory.arrayPosition_oracle();
 		functionFactory.arrayLength_oracle();
+		functionFactory.arrayConcat_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
@@ -587,6 +587,7 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio
 		functionFactory.arrayContainsNull_array_position();
 		functionFactory.arrayPosition_postgresql();
 		functionFactory.arrayLength_cardinality();
+		functionFactory.arrayConcat_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
@@ -454,6 +454,7 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio
 		functionFactory.arrayContainsNull_array_position();
 		functionFactory.arrayPosition_postgresql();
 		functionFactory.arrayLength_cardinality();
+		functionFactory.arrayConcat_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
@@ -315,6 +315,7 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio
 		functionFactory.arrayContains();
 		functionFactory.arrayContainsNull();
 		functionFactory.arrayLength_cardinality();
+		functionFactory.arrayConcat_operator();
 	}
 
 	@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
@@ -193,6 +193,7 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio
 		functionFactory.arrayContainsNull_hsql();
 		functionFactory.arrayPosition_hsql();
 		functionFactory.arrayLength_cardinality();
+		functionFactory.arrayConcat_operator();
 	}
 
 	@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
@@ -272,6 +272,48 @@ public void addAuxiliaryDatabaseObjects(
 						false
 				)
 		);
+		database.addAuxiliaryDatabaseObject(
+				new NamedAuxiliaryDatabaseObject(
+						arrayTypeName + "_concat",
+						database.getDefaultNamespace(),
+						new String[]{ createOrReplaceConcatFunction( arrayTypeName ) },
+						new String[] { "drop function " + arrayTypeName + "_concat" },
+						emptySet(),
+						false
+				)
+		);
+	}
+
+	protected String createOrReplaceConcatFunction(String arrayTypeName) {
+		// Since Oracle has no builtin concat function for varrays and doesn't support varargs,
+		// we have to create a function with a fixed amount of arguments with default that fits "most" cases.
+		// Let's just use 5 for the time being until someone requests more.
+		return createOrReplaceConcatFunction( arrayTypeName, 5 );
+	}
+
+	protected String createOrReplaceConcatFunction(String arrayTypeName, int maxConcatParams) {
+		final StringBuilder sb = new StringBuilder();
+		sb.append( "create or replace function " ).append( arrayTypeName ).append( "_concat(" );
+		sb.append( "arr0 in " ).append( arrayTypeName ).append( ",arr1 in " ).append( arrayTypeName );
+		for ( int i = 2; i < maxConcatParams; i++ ) {
+			sb.append( ",arr" ).append( i ).append( " in " ).append( arrayTypeName )
+					.append( " default " ).append( arrayTypeName ).append( "()" );
+		}
+		sb.append( ") return " ).append( arrayTypeName ).append( " deterministic is res " ).append( arrayTypeName )
+				.append( "; begin if " );
+		String separator = "";
+		for ( int i = 0; i < maxConcatParams; i++ ) {
+			sb.append( separator ).append( "arr" ).append( i ).append( " is null" );
+			separator = " or ";
+		}
+		sb.append( " then return null; end if; " );
+		sb.append( "select * bulk collect into res from (" );
+		separator = "";
+		for ( int i = 0; i < maxConcatParams; i++ ) {
+			sb.append( separator ).append( "select * from table(arr" ).append( i ).append( ')' );
+			separator = " union all ";
+		}
+		return sb.append( "); return res; end;" ).toString();
 	}
 
 	private static String getRawTypeName(String typeName) {
diff --git a/hibernate-core/src/main/java/org/hibernate/dialect/OracleDialect.java b/hibernate-core/src/main/java/org/hibernate/dialect/OracleDialect.java
@@ -318,6 +318,7 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio
 		functionFactory.arrayContainsNull_oracle();
 		functionFactory.arrayPosition_oracle();
 		functionFactory.arrayLength_oracle();
+		functionFactory.arrayConcat_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
@@ -635,6 +635,7 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio
 		functionFactory.arrayContainsNull_array_position();
 		functionFactory.arrayPosition_postgresql();
 		functionFactory.arrayLength_cardinality();
+		functionFactory.arrayConcat_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
@@ -16,11 +16,15 @@
 import org.hibernate.dialect.function.array.ArrayAndElementArgumentTypeResolver;
 import org.hibernate.dialect.function.array.ArrayAndElementArgumentValidator;
 import org.hibernate.dialect.function.array.ArrayArgumentValidator;
+import org.hibernate.dialect.function.array.ArrayConcatArgumentValidator;
+import org.hibernate.dialect.function.array.ArrayConcatFunction;
 import org.hibernate.dialect.function.array.ArrayConstructorFunction;
 import org.hibernate.dialect.function.array.ArrayContainsOperatorFunction;
 import org.hibernate.dialect.function.array.HSQLArrayPositionFunction;
+import org.hibernate.dialect.function.array.OracleArrayConcatFunction;
 import org.hibernate.dialect.function.array.OracleArrayLengthFunction;
 import org.hibernate.dialect.function.array.OracleArrayPositionFunction;
+import org.hibernate.dialect.function.array.PostgreSQLArrayConcatFunction;
 import org.hibernate.dialect.function.array.PostgreSQLArrayPositionFunction;
 import org.hibernate.dialect.function.array.CastingArrayConstructorFunction;
 import org.hibernate.dialect.function.array.OracleArrayAggEmulation;
@@ -2739,4 +2743,25 @@ public void arrayLength_cardinality() {
 	public void arrayLength_oracle() {
 		functionRegistry.register( "array_length", new OracleArrayLengthFunction( typeConfiguration ) );
 	}
+
+	/**
+	 * H2 and HSQLDB array_concat() function
+	 */
+	public void arrayConcat_operator() {
+		functionRegistry.register( "array_concat", new ArrayConcatFunction( "", "||", "" ) );
+	}
+
+	/**
+	 * CockroachDB and PostgreSQL array_concat() function
+	 */
+	public void arrayConcat_postgresql() {
+		functionRegistry.register( "array_concat", new PostgreSQLArrayConcatFunction() );
+	}
+
+	/**
+	 * Oracle array_concat() function
+	 */
+	public void arrayConcat_oracle() {
+		functionRegistry.register( "array_concat", new OracleArrayConcatFunction() );
+	}
 }
diff --git a/hibernate-core/src/main/java/org/hibernate/dialect/function/array/ArrayArgumentValidator.java b/hibernate-core/src/main/java/org/hibernate/dialect/function/array/ArrayArgumentValidator.java
@@ -41,6 +41,14 @@ protected BasicType<?> getElementType(
 			List<? extends SqmTypedNode<?>> arguments,
 			String functionName,
 			TypeConfiguration typeConfiguration) {
+		return getElementType( arrayIndex, arguments, functionName, typeConfiguration );
+	}
+
+	protected BasicType<?> getElementType(
+			int arrayIndex,
+			List<? extends SqmTypedNode<?>> arguments,
+			String functionName,
+			TypeConfiguration typeConfiguration) {
 		final SqmTypedNode<?> arrayArgument = arguments.get( arrayIndex );
 		final SqmExpressible<?> arrayType = arrayArgument.getExpressible().getSqmType();
 		if ( arrayType == null ) {
diff --git a/hibernate-core/src/main/java/org/hibernate/dialect/function/array/ArrayConcatArgumentValidator.java b/hibernate-core/src/main/java/org/hibernate/dialect/function/array/ArrayConcatArgumentValidator.java
@@ -0,0 +1,66 @@
+/*
+ * 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.model.domain.DomainType;
+import org.hibernate.query.sqm.produce.function.ArgumentsValidator;
+import org.hibernate.query.sqm.produce.function.FunctionArgumentException;
+import org.hibernate.query.sqm.tree.SqmTypedNode;
+import org.hibernate.type.BasicPluralType;
+import org.hibernate.type.spi.TypeConfiguration;
+
+/**
+ * A {@link ArgumentsValidator} that validates all arguments are of the same array type.
+ */
+public class ArrayConcatArgumentValidator implements ArgumentsValidator {
+
+	public static final ArgumentsValidator INSTANCE = new ArrayConcatArgumentValidator();
+
+	@Override
+	public void validate(
+			List<? extends SqmTypedNode<?>> arguments,
+			String functionName,
+			TypeConfiguration typeConfiguration) {
+		BasicPluralType<?, ?> arrayType = null;
+		for ( int i = 0; i < arguments.size(); i++ ) {
+			final DomainType<?> sqmType = arguments.get( i ).getExpressible().getSqmType();
+			if ( sqmType != null ) {
+				if ( arrayType == null ) {
+					if ( !( sqmType instanceof BasicPluralType<?, ?> ) ) {
+						throw new FunctionArgumentException(
+								String.format(
+										"Parameter %d of function '%s()' requires an array type, but argument is of type '%s'",
+										i,
+										functionName,
+										sqmType.getTypeName()
+								)
+						);
+					}
+					arrayType = (BasicPluralType<?, ?>) sqmType;
+				}
+				else if ( !arrayType.equals( sqmType ) ) {
+					throw new FunctionArgumentException(
+							String.format(
+									"Parameter %d of function '%s()' requires an array type %s, but argument is of type '%s'",
+									i,
+									functionName,
+									arrayType.getTypeName(),
+									sqmType.getTypeName()
+							)
+					);
+				}
+			}
+		}
+	}
+
+	@Override
+	public String getSignature() {
+		return "(ARRAY array0, ARRAY array1[, ARRAY array2, ...])";
+	}
+}
diff --git a/hibernate-core/src/main/java/org/hibernate/dialect/function/array/ArrayConcatFunction.java b/hibernate-core/src/main/java/org/hibernate/dialect/function/array/ArrayConcatFunction.java
@@ -0,0 +1,56 @@
+/*
+ * 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.StandardArgumentsValidators;
+import org.hibernate.query.sqm.produce.function.StandardFunctionArgumentTypeResolvers;
+import org.hibernate.query.sqm.produce.function.StandardFunctionReturnTypeResolvers;
+import org.hibernate.sql.ast.SqlAstTranslator;
+import org.hibernate.sql.ast.spi.SqlAppender;
+import org.hibernate.sql.ast.tree.SqlAstNode;
+
+/**
+ * Concatenation function for arrays.
+ */
+public class ArrayConcatFunction extends AbstractSqmSelfRenderingFunctionDescriptor {
+
+	private final String prefix;
+	private final String separator;
+	private final String suffix;
+
+	public ArrayConcatFunction(String prefix, String separator, String suffix) {
+		super(
+				"array_concat",
+				StandardArgumentsValidators.composite(
+						StandardArgumentsValidators.min( 2 ),
+						ArrayConcatArgumentValidator.INSTANCE
+				),
+				StandardFunctionReturnTypeResolvers.useFirstNonNull(),
+				StandardFunctionArgumentTypeResolvers.ARGUMENT_OR_IMPLIED_RESULT_TYPE
+		);
+		this.prefix = prefix;
+		this.separator = separator;
+		this.suffix = suffix;
+	}
+
+	@Override
+	public void render(
+			SqlAppender sqlAppender,
+			List<? extends SqlAstNode> sqlAstArguments,
+			SqlAstTranslator<?> walker) {
+		sqlAppender.append( prefix );
+		sqlAstArguments.get( 0 ).accept( walker );
+		for ( int i = 1; i < sqlAstArguments.size(); i++ ) {
+			sqlAppender.append( separator );
+			sqlAstArguments.get( i ).accept( walker );
+		}
+		sqlAppender.append( suffix );
+	}
+}
diff --git a/hibernate-core/src/main/java/org/hibernate/dialect/function/array/OracleArrayConcatFunction.java b/hibernate-core/src/main/java/org/hibernate/dialect/function/array/OracleArrayConcatFunction.java
@@ -0,0 +1,44 @@
+/*
+ * 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;
+
+/**
+ * Oracle concatenation function for arrays.
+ */
+public class OracleArrayConcatFunction extends ArrayConcatFunction {
+
+	public OracleArrayConcatFunction() {
+		super( "(", ",", ")" );
+	}
+
+	@Override
+	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 );
+		sqlAppender.append( arrayTypeName );
+		sqlAppender.append( "_concat" );
+		super.render( sqlAppender, sqlAstArguments, walker );
+	}
+}
diff --git a/hibernate-core/src/main/java/org/hibernate/dialect/function/array/PostgreSQLArrayConcatFunction.java b/hibernate-core/src/main/java/org/hibernate/dialect/function/array/PostgreSQLArrayConcatFunction.java
diff --git a/hibernate-core/src/main/java/org/hibernate/type/BasicArrayType.java b/hibernate-core/src/main/java/org/hibernate/type/BasicArrayType.java
diff --git a/hibernate-core/src/main/java/org/hibernate/type/BasicCollectionType.java b/hibernate-core/src/main/java/org/hibernate/type/BasicCollectionType.java
diff --git a/hibernate-core/src/main/java/org/hibernate/type/ConvertedBasicArrayType.java b/hibernate-core/src/main/java/org/hibernate/type/ConvertedBasicArrayType.java
diff --git a/hibernate-core/src/main/java/org/hibernate/type/ConvertedBasicCollectionType.java b/hibernate-core/src/main/java/org/hibernate/type/ConvertedBasicCollectionType.java
diff --git a/hibernate-core/src/test/java/org/hibernate/orm/test/function/array/ArrayConcatTest.java b/hibernate-core/src/test/java/org/hibernate/orm/test/function/array/ArrayConcatTest.java

Original file line number	Diff line number	Diff line change
`@@ -375,6 +375,7 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio`
`375`	`375`	`functionFactory.arrayContains();`
`376`	`376`	`functionFactory.arrayContainsNull();`
`377`	`377`	`functionFactory.arrayLength_cardinality();`
	`378`	`+ functionFactory.arrayConcat_operator();`
`378`	`379`	`}`
`379`	`380`	`else {`
`380`	`381`	`// Use group_concat until 2.x as listagg was buggy`
Original file line number	Diff line number	Diff line change
`@@ -253,6 +253,7 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio`
`253`	`253`	`functionFactory.arrayContainsNull_hsql();`
`254`	`254`	`functionFactory.arrayPosition_hsql();`
`255`	`255`	`functionFactory.arrayLength_cardinality();`
	`256`	`+ functionFactory.arrayConcat_operator();`
`256`	`257`	`}`
`257`	`258`
`258`	`259`	`@Override`
Original file line number	Diff line number	Diff line change
`@@ -289,6 +289,7 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio`
`289`	`289`	`functionFactory.arrayContainsNull_oracle();`
`290`	`290`	`functionFactory.arrayPosition_oracle();`
`291`	`291`	`functionFactory.arrayLength_oracle();`
	`292`	`+ functionFactory.arrayConcat_oracle();`
`292`	`293`	`}`
`293`	`294`
`294`	`295`	`@Override`
Original file line number	Diff line number	Diff line change
`@@ -315,6 +315,7 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio`
`315`	`315`	`functionFactory.arrayContains();`
`316`	`316`	`functionFactory.arrayContainsNull();`
`317`	`317`	`functionFactory.arrayLength_cardinality();`
	`318`	`+ functionFactory.arrayConcat_operator();`
`318`	`319`	`}`
`319`	`320`
`320`	`321`	`@Override`
Original file line number	Diff line number	Diff line change
`@@ -193,6 +193,7 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio`
`193`	`193`	`functionFactory.arrayContainsNull_hsql();`
`194`	`194`	`functionFactory.arrayPosition_hsql();`
`195`	`195`	`functionFactory.arrayLength_cardinality();`
	`196`	`+ functionFactory.arrayConcat_operator();`
`196`	`197`	`}`
`197`	`198`
`198`	`199`	`@Override`