HHH-17355 Unify array_contains and array_contains_all as well as depr…

…ecate FunctionRenderingSupport in favor of new FunctionRenderer contract

documentation/src/main/asciidoc/userguide/chapters/query/hql/QueryLanguage.adoc

@@ -1233,7 +1233,7 @@ The result of `array_contains` is undefined when the second argument is an array
 ====
 [source, JAVA, indent=0]
 ----
-include::{array-example-dir-hql}/ArrayContainsAllTest.java[tags=hql-array-contains-all-example]
+include::{array-example-dir-hql}/ArrayContainsArrayTest.java[tags=hql-array-contains-array-example]
 ----
 ====
 
@@ -1243,7 +1243,7 @@ To search for `null` elements, the `array_contains_nullable` function must be us
 ====
 [source, JAVA, indent=0]
 ----
-include::{array-example-dir-hql}/ArrayContainsAllTest.java[tags=hql-array-contains-all-nullable-example]
+include::{array-example-dir-hql}/ArrayContainsArrayTest.java[tags=hql-array-contains-array-nullable-example]
 ----
 ====
 

hibernate-community-dialects/src/main/java/org/hibernate/community/dialect/CockroachLegacyDialect.java

@@ -461,19 +461,15 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio
 		functionFactory.listagg_stringAgg( "string" );
 		functionFactory.inverseDistributionOrderedSetAggregates();
 		functionFactory.hypotheticalOrderedSetAggregates_windowEmulation();
-		functionFactory.array_casting();
+		functionFactory.array_postgresql();
 		functionFactory.arrayAggregate();
-		functionFactory.arrayContains_operator();
-		functionFactory.arrayContainsNull_array_position();
 		functionFactory.arrayPosition_postgresql();
 		functionFactory.arrayLength_cardinality();
 		functionFactory.arrayConcat_postgresql();
 		functionFactory.arrayPrepend_postgresql();
 		functionFactory.arrayAppend_postgresql();
-		functionFactory.arrayContainsAll_operator();
-		functionFactory.arrayOverlaps_operator();
-		functionFactory.arrayContainsAllNullable_operator();
-		functionFactory.arrayOverlapsNullable_unnest();
+		functionFactory.arrayContains_postgresql();
+		functionFactory.arrayOverlaps_postgresql();
 		functionFactory.arrayGet_bracket();
 		functionFactory.arraySet_unnest();
 		functionFactory.arrayRemove();

hibernate-community-dialects/src/main/java/org/hibernate/community/dialect/H2LegacyDialect.java

@@ -372,22 +372,18 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio
 				functionFactory.listagg( null );
 				functionFactory.array();
 				functionFactory.arrayAggregate();
-				functionFactory.arrayContains();
-				functionFactory.arrayContainsNull();
 				functionFactory.arrayLength_cardinality();
 				functionFactory.arrayConcat_operator();
 				functionFactory.arrayPrepend_operator();
 				functionFactory.arrayAppend_operator();
-				functionFactory.arrayContainsAll_h2();
-				functionFactory.arrayOverlaps_h2();
-				functionFactory.arrayContainsAllNullable_h2();
-				functionFactory.arrayOverlapsNullable_h2();
+				functionFactory.arrayContains_h2( getMaximumArraySize() );
+				functionFactory.arrayOverlaps_h2( getMaximumArraySize() );
 				functionFactory.arrayGet_h2();
-				functionFactory.arraySet_h2();
-				functionFactory.arrayRemove_h2();
-				functionFactory.arrayRemoveIndex_h2();
+				functionFactory.arraySet_h2( getMaximumArraySize() );
+				functionFactory.arrayRemove_h2( getMaximumArraySize() );
+				functionFactory.arrayRemoveIndex_h2( getMaximumArraySize() );
 				functionFactory.arraySlice();
-				functionFactory.arrayReplace_h2();
+				functionFactory.arrayReplace_h2( getMaximumArraySize() );
 			}
 			else {
 				// Use group_concat until 2.x as listagg was buggy
@@ -399,6 +395,16 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio
 		}
 	}
 
+	/**
+	 * H2 requires a very special emulation, because {@code unnest} is pretty much useless,
+	 * due to https://github.com/h2database/h2database/issues/1815.
+	 * This emulation uses {@code array_get}, {@code array_length} and {@code system_range} functions to roughly achieve the same,
+	 * but requires that {@code system_range} is fed with a "maximum array size".
+	 */
+	protected int getMaximumArraySize() {
+		return 1000;
+	}
+
 	@Override
 	public void augmentPhysicalTableTypes(List<String> tableTypesList) {
 		if ( getVersion().isSameOrAfter( 2 ) ) {

hibernate-community-dialects/src/main/java/org/hibernate/community/dialect/HSQLLegacyDialect.java

@@ -247,19 +247,15 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio
 			functionFactory.rownum();
 		}
 		functionFactory.listagg_groupConcat();
-		functionFactory.array();
+		functionFactory.array_hsql();
 		functionFactory.arrayAggregate();
-		functionFactory.arrayContains_hsql();
-		functionFactory.arrayContainsNull_hsql();
 		functionFactory.arrayPosition_hsql();
 		functionFactory.arrayLength_cardinality();
 		functionFactory.arrayConcat_operator();
 		functionFactory.arrayPrepend_operator();
 		functionFactory.arrayAppend_operator();
-		functionFactory.arrayContainsAll_hsql();
+		functionFactory.arrayContains_hsql();
 		functionFactory.arrayOverlaps_hsql();
-		functionFactory.arrayContainsAllNullable_hsql();
-		functionFactory.arrayOverlapsNullable_unnest();
 		functionFactory.arrayGet_unnest();
 		functionFactory.arraySet_hsql();
 		functionFactory.arrayRemove_hsql();

hibernate-community-dialects/src/main/java/org/hibernate/community/dialect/OracleLegacyDialect.java

@@ -285,17 +285,13 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio
 
 		functionFactory.array_oracle();
 		functionFactory.arrayAggregate_jsonArrayagg();
-		functionFactory.arrayContains_oracle();
-		functionFactory.arrayContainsNull_oracle();
 		functionFactory.arrayPosition_oracle();
 		functionFactory.arrayLength_oracle();
 		functionFactory.arrayConcat_oracle();
 		functionFactory.arrayPrepend_oracle();
 		functionFactory.arrayAppend_oracle();
-		functionFactory.arrayContainsAll_oracle();
+		functionFactory.arrayContains_oracle();
 		functionFactory.arrayOverlaps_oracle();
-		functionFactory.arrayContainsAllNullable_oracle();
-		functionFactory.arrayOverlapsNullable_oracle();
 		functionFactory.arrayGet_oracle();
 		functionFactory.arraySet_oracle();
 		functionFactory.arrayRemove_oracle();

hibernate-community-dialects/src/main/java/org/hibernate/community/dialect/PostgreSQLLegacyDialect.java

@@ -581,19 +581,15 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio
 		functionFactory.locate_positionSubstring();
 		functionFactory.windowFunctions();
 		functionFactory.listagg_stringAgg( "varchar" );
-		functionFactory.array_casting();
+		functionFactory.array_postgresql();
 		functionFactory.arrayAggregate();
-		functionFactory.arrayContains_operator();
-		functionFactory.arrayContainsNull_array_position();
 		functionFactory.arrayPosition_postgresql();
 		functionFactory.arrayLength_cardinality();
 		functionFactory.arrayConcat_postgresql();
 		functionFactory.arrayPrepend_postgresql();
 		functionFactory.arrayAppend_postgresql();
-		functionFactory.arrayContainsAll_operator();
-		functionFactory.arrayOverlaps_operator();
-		functionFactory.arrayContainsAllNullable_operator();
-		functionFactory.arrayOverlapsNullable_unnest();
+		functionFactory.arrayContains_postgresql();
+		functionFactory.arrayOverlaps_postgresql();
 		functionFactory.arrayGet_bracket();
 		functionFactory.arraySet_unnest();
 		functionFactory.arrayRemove();

hibernate-core/src/main/java/org/hibernate/dialect/CockroachDialect.java

@@ -448,19 +448,15 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio
 		functionFactory.listagg_stringAgg( "string" );
 		functionFactory.inverseDistributionOrderedSetAggregates();
 		functionFactory.hypotheticalOrderedSetAggregates_windowEmulation();
-		functionFactory.array_casting();
+		functionFactory.array_postgresql();
 		functionFactory.arrayAggregate();
-		functionFactory.arrayContains_operator();
-		functionFactory.arrayContainsNull_array_position();
 		functionFactory.arrayPosition_postgresql();
 		functionFactory.arrayLength_cardinality();
 		functionFactory.arrayConcat_postgresql();
 		functionFactory.arrayPrepend_postgresql();
 		functionFactory.arrayAppend_postgresql();
-		functionFactory.arrayContainsAll_operator();
-		functionFactory.arrayOverlaps_operator();
-		functionFactory.arrayContainsAllNullable_operator();
-		functionFactory.arrayOverlapsNullable_unnest();
+		functionFactory.arrayContains_postgresql();
+		functionFactory.arrayOverlaps_postgresql();
 		functionFactory.arrayGet_bracket();
 		functionFactory.arraySet_unnest();
 		functionFactory.arrayRemove();

hibernate-core/src/main/java/org/hibernate/dialect/H2Dialect.java

@@ -311,22 +311,28 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio
 		functionFactory.hypotheticalOrderedSetAggregates();
 		functionFactory.array();
 		functionFactory.arrayAggregate();
-		functionFactory.arrayContains();
-		functionFactory.arrayContainsNull();
 		functionFactory.arrayLength_cardinality();
 		functionFactory.arrayConcat_operator();
 		functionFactory.arrayPrepend_operator();
 		functionFactory.arrayAppend_operator();
-		functionFactory.arrayContainsAll_h2();
-		functionFactory.arrayOverlaps_h2();
-		functionFactory.arrayContainsAllNullable_h2();
-		functionFactory.arrayOverlapsNullable_h2();
+		functionFactory.arrayContains_h2( getMaximumArraySize() );
+		functionFactory.arrayOverlaps_h2( getMaximumArraySize() );
 		functionFactory.arrayGet_h2();
-		functionFactory.arraySet_h2();
-		functionFactory.arrayRemove_h2();
-		functionFactory.arrayRemoveIndex_h2();
+		functionFactory.arraySet_h2( getMaximumArraySize() );
+		functionFactory.arrayRemove_h2( getMaximumArraySize() );
+		functionFactory.arrayRemoveIndex_h2( getMaximumArraySize() );
 		functionFactory.arraySlice();
-		functionFactory.arrayReplace_h2();
+		functionFactory.arrayReplace_h2( getMaximumArraySize() );
+	}
+
+	/**
+	 * H2 requires a very special emulation, because {@code unnest} is pretty much useless,
+	 * due to https://github.com/h2database/h2database/issues/1815.
+	 * This emulation uses {@code array_get}, {@code array_length} and {@code system_range} functions to roughly achieve the same,
+	 * but requires that {@code system_range} is fed with a "maximum array size".
+	 */
+	protected int getMaximumArraySize() {
+		return 1000;
 	}
 
 	@Override

hibernate-core/src/main/java/org/hibernate/dialect/HSQLDialect.java

@@ -187,19 +187,15 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio
 		// from v. 2.2.0 ROWNUM() is supported in all modes as the equivalent of Oracle ROWNUM
 		functionFactory.rownum();
 		functionFactory.listagg_groupConcat();
-		functionFactory.array();
+		functionFactory.array_hsql();
 		functionFactory.arrayAggregate();
-		functionFactory.arrayContains_hsql();
-		functionFactory.arrayContainsNull_hsql();
 		functionFactory.arrayPosition_hsql();
 		functionFactory.arrayLength_cardinality();
 		functionFactory.arrayConcat_operator();
 		functionFactory.arrayPrepend_operator();
 		functionFactory.arrayAppend_operator();
-		functionFactory.arrayContainsAll_hsql();
+		functionFactory.arrayContains_hsql();
 		functionFactory.arrayOverlaps_hsql();
-		functionFactory.arrayContainsAllNullable_hsql();
-		functionFactory.arrayOverlapsNullable_unnest();
 		functionFactory.arrayGet_unnest();
 		functionFactory.arraySet_hsql();
 		functionFactory.arrayRemove_hsql();

hibernate-core/src/main/java/org/hibernate/dialect/OracleArrayJdbcType.java

@@ -284,10 +284,10 @@ public void addAuxiliaryDatabaseObjects(
 		);
 		database.addAuxiliaryDatabaseObject(
 				new NamedAuxiliaryDatabaseObject(
-						arrayTypeName + "_contains_all",
+						arrayTypeName + "_contains",
 						database.getDefaultNamespace(),
 						new String[]{
-								"create or replace function " + arrayTypeName + "_contains_all(haystack in " + arrayTypeName +
+								"create or replace function " + arrayTypeName + "_contains(haystack in " + arrayTypeName +
 										", needle in " + arrayTypeName + ", nullable in number) return number deterministic is found number(1,0); begin " +
 										"if haystack is null or needle is null then return null; end if; " +
 										"for i in 1 .. needle.count loop " +
@@ -300,7 +300,7 @@ public void addAuxiliaryDatabaseObjects(
 										"return 1; " +
 										"end;"
 						},
-						new String[] { "drop function " + arrayTypeName + "_contains_all" },
+						new String[] { "drop function " + arrayTypeName + "_contains" },
 						emptySet(),
 						false
 				)

hibernate-core/src/main/java/org/hibernate/dialect/OracleDialect.java

@@ -314,17 +314,13 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio
 
 		functionFactory.array_oracle();
 		functionFactory.arrayAggregate_jsonArrayagg();
-		functionFactory.arrayContains_oracle();
-		functionFactory.arrayContainsNull_oracle();
 		functionFactory.arrayPosition_oracle();
 		functionFactory.arrayLength_oracle();
 		functionFactory.arrayConcat_oracle();
 		functionFactory.arrayPrepend_oracle();
 		functionFactory.arrayAppend_oracle();
-		functionFactory.arrayContainsAll_oracle();
+		functionFactory.arrayContains_oracle();
 		functionFactory.arrayOverlaps_oracle();
-		functionFactory.arrayContainsAllNullable_oracle();
-		functionFactory.arrayOverlapsNullable_oracle();
 		functionFactory.arrayGet_oracle();
 		functionFactory.arraySet_oracle();
 		functionFactory.arrayRemove_oracle();

hibernate-core/src/main/java/org/hibernate/dialect/PostgreSQLDialect.java

@@ -629,19 +629,15 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio
 		functionFactory.locate_positionSubstring();
 		functionFactory.windowFunctions();
 		functionFactory.listagg_stringAgg( "varchar" );
-		functionFactory.array_casting();
+		functionFactory.array_postgresql();
 		functionFactory.arrayAggregate();
-		functionFactory.arrayContains_operator();
-		functionFactory.arrayContainsNull_array_position();
 		functionFactory.arrayPosition_postgresql();
 		functionFactory.arrayLength_cardinality();
 		functionFactory.arrayConcat_postgresql();
 		functionFactory.arrayPrepend_postgresql();
 		functionFactory.arrayAppend_postgresql();
-		functionFactory.arrayContainsAll_operator();
-		functionFactory.arrayOverlaps_operator();
-		functionFactory.arrayContainsAllNullable_operator();
-		functionFactory.arrayOverlapsNullable_unnest();
+		functionFactory.arrayContains_postgresql();
+		functionFactory.arrayOverlaps_postgresql();
 		functionFactory.arrayGet_bracket();
 		functionFactory.arraySet_unnest();
 		functionFactory.arrayRemove();

hibernate-core/src/main/java/org/hibernate/dialect/SpannerDialect.java

@@ -479,7 +479,7 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio
 		functionFactory.listagg_stringAgg( "string" );
 		functionFactory.inverseDistributionOrderedSetAggregates();
 		functionFactory.hypotheticalOrderedSetAggregates();
-		functionFactory.array_withoutKeyword();
+		functionFactory.array_spanner();
 	}
 
 	@Override

hibernate-core/src/main/java/org/hibernate/dialect/function/AggregateWindowEmulationQueryTransformer.java

@@ -129,7 +129,7 @@ public QuerySpec transform(
 			if ( expression == windowFunction ) {
 				finalExpression = new SelfRenderingAggregateFunctionSqlAstExpression(
 						"min",
-						(sqlAppender, sqlAstArguments, walker1) -> {
+						(sqlAppender, sqlAstArguments, returnType, walker1) -> {
 							sqlAppender.appendSql( "min(" );
 							sqlAstArguments.get( 0 ).accept( walker1 );
 							sqlAppender.append( ')' );

hibernate-core/src/main/java/org/hibernate/dialect/function/AvgFunction.java

@@ -11,6 +11,7 @@
 
 import org.hibernate.dialect.Dialect;
 import org.hibernate.metamodel.mapping.JdbcMapping;
+import org.hibernate.query.ReturnableType;
 import org.hibernate.query.sqm.function.AbstractSqmSelfRenderingFunctionDescriptor;
 import org.hibernate.query.sqm.function.FunctionKind;
 import org.hibernate.query.sqm.produce.function.ArgumentTypesValidator;
@@ -62,15 +63,20 @@ public AvgFunction(
 	}
 
 	@Override
-	public void render(SqlAppender sqlAppender, List<? extends SqlAstNode> sqlAstArguments, SqlAstTranslator<?> walker) {
-		render( sqlAppender, sqlAstArguments, null, walker );
+	public void render(
+			SqlAppender sqlAppender,
+			List<? extends SqlAstNode> sqlAstArguments,
+			ReturnableType<?> returnType,
+			SqlAstTranslator<?> walker) {
+		render( sqlAppender, sqlAstArguments, null, returnType, walker );
 	}
 
 	@Override
 	public void render(
 			SqlAppender sqlAppender,
 			List<? extends SqlAstNode> sqlAstArguments,
 			Predicate filter,
+			ReturnableType<?> returnType,
 			SqlAstTranslator<?> translator) {
 		final boolean caseWrapper = filter != null && !translator.supportsFilterClause();
 		sqlAppender.appendSql( "avg(" );
@@ -108,7 +114,12 @@ private void renderArgument(SqlAppender sqlAppender, SqlAstTranslator<?> transla
 		final JdbcMapping sourceMapping = realArg.getExpressionType().getSingleJdbcMapping();
 		// Only cast to float/double if this is an integer
 		if ( sourceMapping.getJdbcType().isInteger() ) {
-			castFunction.render( sqlAppender, Arrays.asList( realArg, new CastTarget(doubleType) ), translator );
+			castFunction.render(
+					sqlAppender,
+					Arrays.asList( realArg, new CastTarget( doubleType ) ),
+					doubleType,
+					translator
+			);
 		}
 		else {
 			translator.render( realArg, defaultArgumentRenderingMode );

hibernate-core/src/main/java/org/hibernate/dialect/function/CaseLeastGreatestEmulation.java

@@ -8,6 +8,7 @@
 
 import java.util.List;
 
+import org.hibernate.query.ReturnableType;
 import org.hibernate.query.sqm.function.AbstractSqmSelfRenderingFunctionDescriptor;
 import org.hibernate.query.sqm.produce.function.ArgumentTypesValidator;
 import org.hibernate.query.sqm.produce.function.StandardArgumentsValidators;
@@ -44,6 +45,7 @@ public CaseLeastGreatestEmulation(boolean least) {
 	public void render(
 			SqlAppender sqlAppender,
 			List<? extends SqlAstNode> arguments,
+			ReturnableType<?> returnType,
 			SqlAstTranslator<?> walker) {
 		final int numberOfArguments = arguments.size();
 		if ( numberOfArguments > 1 ) {

hibernate-core/src/main/java/org/hibernate/dialect/function/CastFunction.java

@@ -11,6 +11,7 @@
 
 import org.hibernate.dialect.Dialect;
 import org.hibernate.metamodel.mapping.JdbcMapping;
+import org.hibernate.query.ReturnableType;
 import org.hibernate.query.sqm.CastType;
 import org.hibernate.query.sqm.function.AbstractSqmSelfRenderingFunctionDescriptor;
 import org.hibernate.query.sqm.produce.function.StandardArgumentsValidators;
@@ -57,7 +58,11 @@ private CastType getBooleanCastType(int preferredSqlTypeCodeForBoolean) {
 	}
 
 	@Override
-	public void render(SqlAppender sqlAppender, List<? extends SqlAstNode> arguments, SqlAstTranslator<?> walker) {
+	public void render(
+			SqlAppender sqlAppender,
+			List<? extends SqlAstNode> arguments,
+			ReturnableType<?> returnType,
+			SqlAstTranslator<?> walker) {
 		final Expression source = (Expression) arguments.get( 0 );
 		final JdbcMapping sourceMapping = source.getExpressionType().getSingleJdbcMapping();
 		final CastType sourceType = getCastType( sourceMapping );