HHH-17355 Add array_positions and array_positions_list functions

Author: beikov

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

@@ -1120,6 +1120,8 @@ The following functions deal with SQL array types, which are not supported on ev
 | `array()` | Creates an array based on the passed arguments
 | `array_agg()` | Aggregates row values into an array
 | `array_position()` | Determines the position of an element in an array
+| `array_positions()` | Determines all positions of an element in an array
+| `array_positions_list()` | Like `array_positions`, but returns the result as `List<Integer>`
 | `array_length()` | Determines the length of an array
 | `array_concat()` | Concatenates array with each other in order
 | `array_prepend()` | Prepends element to array
@@ -1175,6 +1177,20 @@ include::{array-example-dir-hql}/ArrayPositionTest.java[tags=hql-array-position-
 ----
 ====
 
+[[hql-array-positions-functions]]
+===== `array_positions()` and `array_positions_list()`
+
+Returns an `int[]` of 1-based positions of matching elements in the array. Returns an empty array if the element is not found and `null` if the array is `null`.
+To retrieve the result as `List<Integer>`, use the `array_positions_list()` function.
+
+[[hql-array-positions-example]]
+====
+[source, JAVA, indent=0]
+----
+include::{array-example-dir-hql}/ArrayPositionsTest.java[tags=hql-array-positions-example]
+----
+====
+
 [[hql-array-length-functions]]
 ===== `array_length()`
 

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

@@ -464,6 +464,7 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio
 		functionFactory.array_postgresql();
 		functionFactory.arrayAggregate();
 		functionFactory.arrayPosition_postgresql();
+		functionFactory.arrayPositions_postgresql();
 		functionFactory.arrayLength_cardinality();
 		functionFactory.arrayConcat_postgresql();
 		functionFactory.arrayPrepend_postgresql();

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

@@ -372,6 +372,8 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio
 				functionFactory.listagg( null );
 				functionFactory.array();
 				functionFactory.arrayAggregate();
+				functionFactory.arrayPosition_h2( getMaximumArraySize() );
+				functionFactory.arrayPositions_h2( getMaximumArraySize() );
 				functionFactory.arrayLength_cardinality();
 				functionFactory.arrayConcat_operator();
 				functionFactory.arrayPrepend_operator();

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

@@ -250,6 +250,7 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio
 		functionFactory.array_hsql();
 		functionFactory.arrayAggregate();
 		functionFactory.arrayPosition_hsql();
+		functionFactory.arrayPositions_hsql();
 		functionFactory.arrayLength_cardinality();
 		functionFactory.arrayConcat_operator();
 		functionFactory.arrayPrepend_operator();

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

@@ -286,6 +286,7 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio
 		functionFactory.array_oracle();
 		functionFactory.arrayAggregate_jsonArrayagg();
 		functionFactory.arrayPosition_oracle();
+		functionFactory.arrayPositions_oracle();
 		functionFactory.arrayLength_oracle();
 		functionFactory.arrayConcat_oracle();
 		functionFactory.arrayPrepend_oracle();

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

@@ -584,6 +584,7 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio
 		functionFactory.array_postgresql();
 		functionFactory.arrayAggregate();
 		functionFactory.arrayPosition_postgresql();
+		functionFactory.arrayPositions_postgresql();
 		functionFactory.arrayLength_cardinality();
 		functionFactory.arrayConcat_postgresql();
 		functionFactory.arrayPrepend_postgresql();

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

@@ -451,6 +451,7 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio
 		functionFactory.array_postgresql();
 		functionFactory.arrayAggregate();
 		functionFactory.arrayPosition_postgresql();
+		functionFactory.arrayPositions_postgresql();
 		functionFactory.arrayLength_cardinality();
 		functionFactory.arrayConcat_postgresql();
 		functionFactory.arrayPrepend_postgresql();

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

@@ -311,6 +311,8 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio
 		functionFactory.hypotheticalOrderedSetAggregates();
 		functionFactory.array();
 		functionFactory.arrayAggregate();
+		functionFactory.arrayPosition_h2( getMaximumArraySize() );
+		functionFactory.arrayPositions_h2( getMaximumArraySize() );
 		functionFactory.arrayLength_cardinality();
 		functionFactory.arrayConcat_operator();
 		functionFactory.arrayPrepend_operator();

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

@@ -190,6 +190,7 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio
 		functionFactory.array_hsql();
 		functionFactory.arrayAggregate();
 		functionFactory.arrayPosition_hsql();
+		functionFactory.arrayPositions_hsql();
 		functionFactory.arrayLength_cardinality();
 		functionFactory.arrayConcat_operator();
 		functionFactory.arrayPrepend_operator();

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

@@ -515,6 +515,32 @@ public void addAuxiliaryDatabaseObjects(
 						false
 				)
 		);
+		database.addAuxiliaryDatabaseObject(
+				new NamedAuxiliaryDatabaseObject(
+						arrayTypeName + "_positions",
+						database.getDefaultNamespace(),
+						new String[]{
+								"create or replace function " + arrayTypeName + "_positions(arr in " + arrayTypeName +
+										", elem in " + getRawTypeName( elementType ) + ") return sdo_ordinate_array deterministic is " +
+										"res sdo_ordinate_array:=sdo_ordinate_array(); 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 null then res.extend; res(res.last):=i; end if; " +
+										"end loop; " +
+										"else " +
+										"for i in 1 .. arr.count loop " +
+										"if arr(i)=elem then res.extend; res(res.last):=i; end if; " +
+										"end loop; " +
+										"end if; " +
+										"return res; " +
+										"end;"
+						},
+						new String[] { "drop function " + arrayTypeName + "_positions" },
+						emptySet(),
+						false
+				)
+		);
 	}
 
 	protected String createOrReplaceConcatFunction(String arrayTypeName) {