HHH-17335 Add array_contains quantified functions

Author: beikov

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

@@ -1195,6 +1195,52 @@ include::{array-example-dir-hql}/ArrayConcatTest.java[tags=hql-array-concat-exam
 ----
 ====
 
+[[hql-array-contains-quantified-functions]]
+===== `array_contains_all()` and `array_contains_any()`
+
+Checks if the first array argument contains all or any of the elements of the second array argument.
+Returns `null` if either of the arguments is `null`. The result of the functions
+is undefined when the second array argument contains a `null`.
+
+[[hql-array-contains-all-example]]
+====
+[source, JAVA, indent=0]
+----
+include::{array-example-dir-hql}/ArrayContainsAllTest.java[tags=hql-array-contains-all-example]
+----
+====
+
+[[hql-array-contains-any-example]]
+====
+[source, JAVA, indent=0]
+----
+include::{array-example-dir-hql}/ArrayContainsAnyTest.java[tags=hql-array-contains-any-example]
+----
+====
+
+[[hql-array-contains-quantified-functions]]
+===== `array_contains_all_nullable()` & `array_contains_any_nullable()`
+
+Checks if the first array argument contains all or any of the elements of the second array argument.
+Returns `null` if either of the arguments is `null`. Contrary to `array_contains_all()` and `array_contains_any()`,
+these functions use the `distinct from` operator to also support searching for `null` elements.
+
+[[hql-array-contains-all-nullable-example]]
+====
+[source, JAVA, indent=0]
+----
+include::{array-example-dir-hql}/ArrayContainsAllTest.java[tags=hql-array-contains-all-nullable-example]
+----
+====
+
+[[hql-array-contains-any-nullable-example]]
+====
+[source, JAVA, indent=0]
+----
+include::{array-example-dir-hql}/ArrayContainsAnyTest.java[tags=hql-array-contains-any-nullable-example]
+----
+====
+
 [[hql-user-defined-functions]]
 ==== Native and user-defined functions
 

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

@@ -468,6 +468,10 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio
 		functionFactory.arrayPosition_postgresql();
 		functionFactory.arrayLength_cardinality();
 		functionFactory.arrayConcat_postgresql();
+		functionFactory.arrayContainsAll_operator();
+		functionFactory.arrayContainsAny_operator();
+		functionFactory.arrayContainsAllNullable_operator();
+		functionFactory.arrayContainsAnyNullable_operator();
 
 		functionContributions.getFunctionRegistry().register(
 				"trunc",

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

@@ -376,6 +376,10 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio
 				functionFactory.arrayContainsNull();
 				functionFactory.arrayLength_cardinality();
 				functionFactory.arrayConcat_operator();
+				functionFactory.arrayContainsAll_h2();
+				functionFactory.arrayContainsAny_h2();
+				functionFactory.arrayContainsAllNullable_h2();
+				functionFactory.arrayContainsAnyNullable_h2();
 			}
 			else {
 				// Use group_concat until 2.x as listagg was buggy

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

@@ -254,6 +254,10 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio
 		functionFactory.arrayPosition_hsql();
 		functionFactory.arrayLength_cardinality();
 		functionFactory.arrayConcat_operator();
+		functionFactory.arrayContainsAll_hsql();
+		functionFactory.arrayContainsAny_hsql();
+		functionFactory.arrayContainsAllNullable_hsql();
+		functionFactory.arrayContainsAnyNullable_hsql();
 	}
 
 	@Override

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

@@ -290,6 +290,10 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio
 		functionFactory.arrayPosition_oracle();
 		functionFactory.arrayLength_oracle();
 		functionFactory.arrayConcat_oracle();
+		functionFactory.arrayContainsAll_oracle();
+		functionFactory.arrayContainsAny_oracle();
+		functionFactory.arrayContainsAllNullable_oracle();
+		functionFactory.arrayContainsAnyNullable_oracle();
 	}
 
 	@Override

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

@@ -588,6 +588,10 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio
 		functionFactory.arrayPosition_postgresql();
 		functionFactory.arrayLength_cardinality();
 		functionFactory.arrayConcat_postgresql();
+		functionFactory.arrayContainsAll_operator();
+		functionFactory.arrayContainsAny_operator();
+		functionFactory.arrayContainsAllNullable_operator();
+		functionFactory.arrayContainsAnyNullable_operator();
 
 		if ( getVersion().isSameOrAfter( 9, 4 ) ) {
 			functionFactory.makeDateTimeTimestamp();

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

@@ -455,6 +455,10 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio
 		functionFactory.arrayPosition_postgresql();
 		functionFactory.arrayLength_cardinality();
 		functionFactory.arrayConcat_postgresql();
+		functionFactory.arrayContainsAll_operator();
+		functionFactory.arrayContainsAny_operator();
+		functionFactory.arrayContainsAllNullable_operator();
+		functionFactory.arrayContainsAnyNullable_operator();
 
 		functionContributions.getFunctionRegistry().register(
 				"trunc",

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

@@ -316,6 +316,10 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio
 		functionFactory.arrayContainsNull();
 		functionFactory.arrayLength_cardinality();
 		functionFactory.arrayConcat_operator();
+		functionFactory.arrayContainsAll_h2();
+		functionFactory.arrayContainsAny_h2();
+		functionFactory.arrayContainsAllNullable_h2();
+		functionFactory.arrayContainsAnyNullable_h2();
 	}
 
 	@Override

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

@@ -194,6 +194,10 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio
 		functionFactory.arrayPosition_hsql();
 		functionFactory.arrayLength_cardinality();
 		functionFactory.arrayConcat_operator();
+		functionFactory.arrayContainsAll_hsql();
+		functionFactory.arrayContainsAny_hsql();
+		functionFactory.arrayContainsAllNullable_hsql();
+		functionFactory.arrayContainsAnyNullable_hsql();
 	}
 
 	@Override

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

@@ -282,6 +282,51 @@ public void addAuxiliaryDatabaseObjects(
 						false
 				)
 		);
+		database.addAuxiliaryDatabaseObject(
+				new NamedAuxiliaryDatabaseObject(
+						arrayTypeName + "_contains_all",
+						database.getDefaultNamespace(),
+						new String[]{
+								"create or replace function " + arrayTypeName + "_contains_all(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 " +
+										"found := 0; " +
+										"for j in 1 .. haystack.count loop " +
+										"if nullable = 1 and needle(i) is null and haystack(j) is null or needle(i)=haystack(j) then found := 1; exit; end if; " +
+										"end loop; " +
+										"if found = 0 then return 0; end if;" +
+										"end loop; " +
+										"return 1; " +
+										"end;"
+						},
+						new String[] { "drop function " + arrayTypeName + "_contains_all" },
+						emptySet(),
+						false
+				)
+		);
+		database.addAuxiliaryDatabaseObject(
+				new NamedAuxiliaryDatabaseObject(
+						arrayTypeName + "_contains_any",
+						database.getDefaultNamespace(),
+						new String[]{
+								"create or replace function " + arrayTypeName + "_contains_any(haystack in " + arrayTypeName +
+										", needle in " + arrayTypeName + ", nullable in number) return number deterministic is begin " +
+										"if haystack is null or needle is null then return null; end if; " +
+										"if needle.count = 0 then return 1; end if; " +
+										"for i in 1 .. needle.count loop " +
+										"for j in 1 .. haystack.count loop " +
+										"if nullable = 1 and needle(i) is null and haystack(j) is null or needle(i)=haystack(j) then return 1; end if; " +
+										"end loop; " +
+										"end loop; " +
+										"return 0; " +
+										"end;"
+						},
+						new String[] { "drop function " + arrayTypeName + "_contains_any" },
+						emptySet(),
+						false
+				)
+		);
 	}
 
 	protected String createOrReplaceConcatFunction(String arrayTypeName) {