HHH-18497 Add xmlexists function

beikov · beikov · commit af09813ced5d · 2024-09-23T15:03:22.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
@@ -2177,6 +2177,7 @@ it is necessary to enable the `hibernate.query.hql.xml_functions_enabled` config
 | `xmlconcat()` | Concatenates multiple XML fragments to each other
 | `xmlpi()` | Constructs an XML processing instruction
 | `xmlquery()` | Extracts content from XML document using XQuery or XPath
+| `xmlexists()` | Checks if an XQuery or XPath expression exists in an XML document
 |===
 
 
@@ -2325,6 +2326,30 @@ include::{xml-example-dir-hql}/XmlQueryTest.java[tags=hql-xmlquery-example]
 
 WARNING: SAP HANA, MySQL, MariaDB and HSQLDB do not support this function.
 
+[[hql-xmlexists-function]]
+===== `xmlexists()`
+
+Checks if an XQuery or XPath expression exists in an XML document.
+
+[[hql-xmlexists-bnf]]
+[source, antlrv4, indent=0]
+----
+include::{extrasdir}/xmlexists_bnf.txt[]
+----
+
+The first argument represents the XQuery or XPath expression.
+The second argument after the `passing` keyword represents the XML document.
+
+[[hql-xmlexists-example]]
+====
+[source, java, indent=0]
+----
+include::{xml-example-dir-hql}/XmlExistsTest.java[tags=hql-xmlexists-example]
+----
+====
+
+WARNING: SAP HANA, MySQL, MariaDB and HSQLDB do not support this function.
+
 [[hql-user-defined-functions]]
 ==== Native and user-defined functions
 
diff --git a/documentation/src/main/asciidoc/userguide/chapters/query/hql/extras/xmlexists_bnf.txt b/documentation/src/main/asciidoc/userguide/chapters/query/hql/extras/xmlexists_bnf.txt
@@ -0,0 +1 @@
+"xmlexists(" expression "passing" expression ")"
diff --git a/hibernate-community-dialects/src/main/java/org/hibernate/community/dialect/DB2LegacyDialect.java b/hibernate-community-dialects/src/main/java/org/hibernate/community/dialect/DB2LegacyDialect.java
@@ -447,6 +447,7 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio
 		functionFactory.xmlconcat();
 		functionFactory.xmlpi();
 		functionFactory.xmlquery_db2();
+		functionFactory.xmlexists();
 	}
 
 	@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
@@ -332,6 +332,7 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio
 		functionFactory.xmlconcat();
 		functionFactory.xmlpi();
 		functionFactory.xmlquery_oracle();
+		functionFactory.xmlexists();
 	}
 
 	@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
@@ -675,6 +675,7 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio
 		functionFactory.xmlconcat();
 		functionFactory.xmlpi();
 		functionFactory.xmlquery_postgresql();
+		functionFactory.xmlexists();
 
 		if ( getVersion().isSameOrAfter( 9, 4 ) ) {
 			functionFactory.makeDateTimeTimestamp();
diff --git a/hibernate-community-dialects/src/main/java/org/hibernate/community/dialect/SQLServerLegacyDialect.java b/hibernate-community-dialects/src/main/java/org/hibernate/community/dialect/SQLServerLegacyDialect.java
@@ -419,6 +419,7 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio
 		functionFactory.xmlconcat_sqlserver();
 		functionFactory.xmlpi_sqlserver();
 		functionFactory.xmlquery_sqlserver();
+		functionFactory.xmlexists_sqlserver();
 		if ( getVersion().isSameOrAfter( 14 ) ) {
 			functionFactory.listagg_stringAggWithinGroup( "varchar(max)" );
 			functionFactory.jsonArrayAgg_sqlserver( getVersion().isSameOrAfter( 16 ) );
diff --git a/hibernate-core/src/main/antlr/org/hibernate/grammars/hql/HqlLexer.g4 b/hibernate-core/src/main/antlr/org/hibernate/grammars/hql/HqlLexer.g4
@@ -332,6 +332,7 @@ WITHOUT				: [wW] [iI] [tT] [hH] [oO] [uU] [tT];
 WRAPPER				: [wW] [rR] [aA] [pP] [pP] [eE] [rR];
 XMLATTRIBUTES		: [xX] [mM] [lL] [aA] [tT] [tT] [rR] [iI] [bB] [uU] [tT] [eE] [sS];
 XMLELEMENT			: [xX] [mM] [lL] [eE] [lL] [eE] [mM] [eE] [nN] [tT];
+XMLEXISTS			: [xX] [mM] [lL] [eE] [xX] [iI] [sS] [tT] [sS];
 XMLFOREST			: [xX] [mM] [lL] [fF] [oO] [rR] [eE] [sS] [tT];
 XMLPI				: [xX] [mM] [lL] [pP] [iI];
 XMLQUERY			: [xX] [mM] [lL] [qQ] [uU] [eE] [rR] [yY];
diff --git a/hibernate-core/src/main/antlr/org/hibernate/grammars/hql/HqlParser.g4 b/hibernate-core/src/main/antlr/org/hibernate/grammars/hql/HqlParser.g4
@@ -1722,6 +1722,7 @@ xmlFunction
 	| xmlforestFunction
 	| xmlpiFunction
 	| xmlqueryFunction
+	| xmlexistsFunction
 	;
 
 /**
@@ -1759,6 +1760,13 @@ xmlqueryFunction
 	: XMLQUERY LEFT_PAREN expression PASSING expression RIGHT_PAREN
 	;
 
+/**
+ * The 'xmlexists()' function
+ */
+xmlexistsFunction
+	: XMLEXISTS LEFT_PAREN expression PASSING expression RIGHT_PAREN
+	;
+
 /**
  * Support for "soft" keywords which may be used as identifiers
  *
@@ -1967,6 +1975,7 @@ xmlqueryFunction
 	| WRAPPER
 	| XMLATTRIBUTES
 	| XMLELEMENT
+	| XMLEXISTS
 	| XMLFOREST
 	| XMLPI
 	| XMLQUERY
diff --git a/hibernate-core/src/main/java/org/hibernate/dialect/DB2Dialect.java b/hibernate-core/src/main/java/org/hibernate/dialect/DB2Dialect.java
@@ -432,6 +432,7 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio
 		functionFactory.xmlconcat();
 		functionFactory.xmlpi();
 		functionFactory.xmlquery_db2();
+		functionFactory.xmlexists();
 	}
 
 	@Override
diff --git a/hibernate-core/src/main/java/org/hibernate/dialect/OracleDialect.java b/hibernate-core/src/main/java/org/hibernate/dialect/OracleDialect.java
@@ -422,6 +422,7 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio
 		functionFactory.xmlconcat();
 		functionFactory.xmlpi();
 		functionFactory.xmlquery_oracle();
+		functionFactory.xmlexists();
 	}
 
 	@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
@@ -636,6 +636,7 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio
 		functionFactory.xmlconcat();
 		functionFactory.xmlpi();
 		functionFactory.xmlquery_postgresql();
+		functionFactory.xmlexists();
 
 		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/SQLServerDialect.java b/hibernate-core/src/main/java/org/hibernate/dialect/SQLServerDialect.java
@@ -437,6 +437,7 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio
 		functionFactory.xmlconcat_sqlserver();
 		functionFactory.xmlpi_sqlserver();
 		functionFactory.xmlquery_sqlserver();
+		functionFactory.xmlexists_sqlserver();
 		if ( getVersion().isSameOrAfter( 14 ) ) {
 			functionFactory.listagg_stringAggWithinGroup( "varchar(max)" );
 			functionFactory.jsonArrayAgg_sqlserver( getVersion().isSameOrAfter( 16 ) );
diff --git a/hibernate-core/src/main/java/org/hibernate/dialect/function/xml/SQLServerXmlExistsFunction.java b/hibernate-core/src/main/java/org/hibernate/dialect/function/xml/SQLServerXmlExistsFunction.java
@@ -0,0 +1,46 @@
+/*
+ * SPDX-License-Identifier: LGPL-2.1-or-later
+ * Copyright Red Hat Inc. and Hibernate Authors
+ */
+package org.hibernate.dialect.function.xml;
+
+import java.util.List;
+
+import org.hibernate.dialect.function.json.ExpressionTypeHelper;
+import org.hibernate.query.ReturnableType;
+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;
+import org.hibernate.type.spi.TypeConfiguration;
+
+/**
+ * SQL Server xmlexists function.
+ */
+public class SQLServerXmlExistsFunction extends XmlExistsFunction {
+
+	public SQLServerXmlExistsFunction(TypeConfiguration typeConfiguration) {
+		super( typeConfiguration );
+	}
+
+	@Override
+	public void render(
+			SqlAppender sqlAppender,
+			List<? extends SqlAstNode> sqlAstArguments,
+			ReturnableType<?> returnType,
+			SqlAstTranslator<?> walker) {
+		final Expression xmlDocument = (Expression) sqlAstArguments.get( 1 );
+		final boolean needsCast = !ExpressionTypeHelper.isXml( xmlDocument );
+		sqlAppender.appendSql( '(' );
+		if ( needsCast ) {
+			sqlAppender.appendSql( "cast(" );
+		}
+		sqlAstArguments.get( 1 ).accept( walker );
+		if ( needsCast ) {
+			sqlAppender.appendSql( " as xml)" );
+		}
+		sqlAppender.appendSql( ".exist(" );
+		sqlAstArguments.get( 0 ).accept( walker );
+		sqlAppender.appendSql( ")=1)" );
+	}
+}
diff --git a/hibernate-core/src/main/java/org/hibernate/dialect/function/xml/XmlExistsFunction.java b/hibernate-core/src/main/java/org/hibernate/dialect/function/xml/XmlExistsFunction.java
@@ -0,0 +1,71 @@
+/*
+ * SPDX-License-Identifier: LGPL-2.1-or-later
+ * Copyright Red Hat Inc. and Hibernate Authors
+ */
+package org.hibernate.dialect.function.xml;
+
+import java.util.List;
+
+import org.hibernate.dialect.function.json.ExpressionTypeHelper;
+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;
+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;
+import org.hibernate.sql.ast.tree.expression.Expression;
+import org.hibernate.type.spi.TypeConfiguration;
+
+import static org.hibernate.query.sqm.produce.function.FunctionParameterType.IMPLICIT_XML;
+import static org.hibernate.query.sqm.produce.function.FunctionParameterType.STRING;
+import static org.hibernate.query.sqm.produce.function.FunctionParameterType.XML;
+
+/**
+ * Standard xmlexists function.
+ */
+public class XmlExistsFunction extends AbstractSqmSelfRenderingFunctionDescriptor {
+
+	public XmlExistsFunction(TypeConfiguration typeConfiguration) {
+		super(
+				"xmlexists",
+				FunctionKind.NORMAL,
+				StandardArgumentsValidators.composite(
+						new ArgumentTypesValidator( null, STRING, IMPLICIT_XML )
+				),
+				StandardFunctionReturnTypeResolvers.invariant(
+						typeConfiguration.getBasicTypeRegistry().getRegisteredType( Boolean.class )
+				),
+				StandardFunctionArgumentTypeResolvers.invariant( typeConfiguration, STRING, XML )
+		);
+	}
+
+	@Override
+	public boolean isPredicate() {
+		return true;
+	}
+
+	@Override
+	public void render(
+			SqlAppender sqlAppender,
+			List<? extends SqlAstNode> sqlAstArguments,
+			ReturnableType<?> returnType,
+			SqlAstTranslator<?> walker) {
+		final Expression xmlDocument = (Expression) sqlAstArguments.get( 1 );
+		final boolean needsCast = !ExpressionTypeHelper.isXml( xmlDocument );
+		sqlAppender.appendSql( "xmlexists(" );
+		sqlAstArguments.get( 0 ).accept( walker );
+		sqlAppender.appendSql( " passing " );
+		if ( needsCast ) {
+			sqlAppender.appendSql( "xmlparse(document " );
+		}
+		sqlAstArguments.get( 1 ).accept( walker );
+		if ( needsCast ) {
+			sqlAppender.appendSql( ')' );
+		}
+		sqlAppender.appendSql( ')' );
+	}
+}
diff --git a/hibernate-core/src/main/java/org/hibernate/query/criteria/HibernateCriteriaBuilder.java b/hibernate-core/src/main/java/org/hibernate/query/criteria/HibernateCriteriaBuilder.java
@@ -4129,6 +4129,22 @@ default <E> JpaPredicate collectionOverlapsNullable(Collection<E> collection1, E
 	@Incubating
 	JpaExpression<String> xmlquery(Expression<String> query, Expression<?> xmlDocument);
 
+	/**
+	 * Checks if the given XPath or XQuery query exists in the given XML document.
+	 *
+	 * @since 7.0
+	 */
+	@Incubating
+	JpaExpression<Boolean> xmlexists(String query, Expression<?> xmlDocument);
+
+	/**
+	 * Checks if the given XPath or XQuery query exists in the given XML document.
+	 *
+	 * @since 7.0
+	 */
+	@Incubating
+	JpaExpression<Boolean> xmlexists(Expression<String> query, Expression<?> xmlDocument);
+
 	/**
 	 * Creates a named expression. The name is important for the result of the expression,
 	 * e.g. when building an {@code xmlforest}, the name acts as the XML element name.
diff --git a/hibernate-core/src/main/java/org/hibernate/query/criteria/spi/HibernateCriteriaBuilderDelegate.java b/hibernate-core/src/main/java/org/hibernate/query/criteria/spi/HibernateCriteriaBuilderDelegate.java
@@ -3693,6 +3693,18 @@ public JpaExpression<String> xmlquery(Expression<String> query, Expression<?> xm
 		return criteriaBuilder.xmlquery( query, xmlDocument );
 	}
 
+	@Override
+	@Incubating
+	public JpaExpression<Boolean> xmlexists(String query, Expression<?> xmlDocument) {
+		return criteriaBuilder.xmlexists( query, xmlDocument );
+	}
+
+	@Override
+	@Incubating
+	public JpaExpression<Boolean> xmlexists(Expression<String> query, Expression<?> xmlDocument) {
+		return criteriaBuilder.xmlexists( query, xmlDocument );
+	}
+
 	@Override
 	@Incubating
 	public <T> JpaExpression<T> named(Expression<T> expression, String name) {
diff --git a/hibernate-core/src/main/java/org/hibernate/query/hql/internal/SemanticQueryBuilder.java b/hibernate-core/src/main/java/org/hibernate/query/hql/internal/SemanticQueryBuilder.java
@@ -3051,6 +3051,14 @@ public SqmExpression<?> visitXmlqueryFunction(HqlParser.XmlqueryFunctionContext
 		return creationContext.getNodeBuilder().xmlquery( query, xmlDocument );
 	}
 
+	@Override
+	public SqmExpression<?> visitXmlexistsFunction(HqlParser.XmlexistsFunctionContext ctx) {
+		checkXmlFunctionsEnabled( ctx );
+		final SqmExpression<String> query = (SqmExpression<String>) ctx.expression( 0 ).accept( this );
+		final SqmExpression<?> xmlDocument = (SqmExpression<?>) ctx.expression( 1 ).accept( this );
+		return creationContext.getNodeBuilder().xmlexists( query, xmlDocument );
+	}
+
 	private void checkXmlFunctionsEnabled(ParserRuleContext ctx) {
 		if ( !creationOptions.isXmlFunctionsEnabled() ) {
 			throw new SemanticException(
diff --git a/hibernate-core/src/main/java/org/hibernate/query/sqm/NodeBuilder.java b/hibernate-core/src/main/java/org/hibernate/query/sqm/NodeBuilder.java
@@ -783,6 +783,12 @@ <T> SqmJsonValueExpression<T> jsonValue(
 	@Override
 	SqmExpression<String> xmlquery(Expression<String> query, Expression<?> xmlDocument);
 
+	@Override
+	SqmExpression<Boolean> xmlexists(String query, Expression<?> xmlDocument);
+
+	@Override
+	SqmExpression<Boolean> xmlexists(Expression<String> query, Expression<?> xmlDocument);
+
 	// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 	// Covariant overrides
 
diff --git a/hibernate-core/src/main/java/org/hibernate/query/sqm/internal/SqmCriteriaNodeBuilder.java b/hibernate-core/src/main/java/org/hibernate/query/sqm/internal/SqmCriteriaNodeBuilder.java
@@ -5778,4 +5778,18 @@ public SqmExpression<String> xmlquery(Expression<String> query, Expression<?> xm
 				queryEngine
 		);
 	}
+
+	@Override
+	public SqmExpression<Boolean> xmlexists(String query, Expression<?> xmlDocument) {
+		return xmlexists( value( query ), xmlDocument );
+	}
+
+	@Override
+	public SqmExpression<Boolean> xmlexists(Expression<String> query, Expression<?> xmlDocument) {
+		return getFunctionDescriptor( "xmlexists" ).generateSqmExpression(
+				asList( (SqmTypedNode<?>) query, (SqmTypedNode<?>) xmlDocument ),
+				null,
+				queryEngine
+		);
+	}
 }
diff --git a/hibernate-core/src/test/java/org/hibernate/orm/test/function/xml/XmlExistsTest.java b/hibernate-core/src/test/java/org/hibernate/orm/test/function/xml/XmlExistsTest.java
@@ -0,0 +1,36 @@
+/*
+ * SPDX-License-Identifier: LGPL-2.1-or-later
+ * Copyright Red Hat Inc. and Hibernate Authors
+ */
+package org.hibernate.orm.test.function.xml;
+
+import org.hibernate.cfg.QuerySettings;
+
+import org.hibernate.testing.orm.junit.DialectFeatureChecks;
+import org.hibernate.testing.orm.junit.DomainModel;
+import org.hibernate.testing.orm.junit.RequiresDialectFeature;
+import org.hibernate.testing.orm.junit.ServiceRegistry;
+import org.hibernate.testing.orm.junit.SessionFactory;
+import org.hibernate.testing.orm.junit.SessionFactoryScope;
+import org.hibernate.testing.orm.junit.Setting;
+import org.junit.jupiter.api.Test;
+
+/**
+ * @author Christian Beikov
+ */
+@DomainModel
+@SessionFactory
+@ServiceRegistry(settings = @Setting(name = QuerySettings.XML_FUNCTIONS_ENABLED, value = "true"))
+@RequiresDialectFeature( feature = DialectFeatureChecks.SupportsXmlexists.class)
+public class XmlExistsTest {
+
+	@Test
+	public void testSimple(SessionFactoryScope scope) {
+		scope.inSession( em -> {
+			//tag::hql-xmlexists-example[]
+			em.createQuery( "select xmlexists('/a/val' passing '<a><val>asd</val></a>')" ).getResultList();
+			//end::hql-xmlexists-example[]
+		} );
+	}
+
+}
diff --git a/hibernate-core/src/test/java/org/hibernate/orm/test/query/hql/XmlFunctionTests.java b/hibernate-core/src/test/java/org/hibernate/orm/test/query/hql/XmlFunctionTests.java
diff --git a/hibernate-testing/src/main/java/org/hibernate/testing/orm/junit/DialectFeatureChecks.java b/hibernate-testing/src/main/java/org/hibernate/testing/orm/junit/DialectFeatureChecks.java

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+"xmlexists(" expression "passing" expression ")"`
Original file line number	Diff line number	Diff line change
`@@ -447,6 +447,7 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio`
`447`	`447`	`functionFactory.xmlconcat();`
`448`	`448`	`functionFactory.xmlpi();`
`449`	`449`	`functionFactory.xmlquery_db2();`
	`450`	`+ functionFactory.xmlexists();`
`450`	`451`	`}`
`451`	`452`
`452`	`453`	`@Override`
Original file line number	Diff line number	Diff line change
`@@ -332,6 +332,7 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio`
`332`	`332`	`functionFactory.xmlconcat();`
`333`	`333`	`functionFactory.xmlpi();`
`334`	`334`	`functionFactory.xmlquery_oracle();`
	`335`	`+ functionFactory.xmlexists();`
`335`	`336`	`}`
`336`	`337`
`337`	`338`	`@Override`
Original file line number	Diff line number	Diff line change
`@@ -432,6 +432,7 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio`
`432`	`432`	`functionFactory.xmlconcat();`
`433`	`433`	`functionFactory.xmlpi();`
`434`	`434`	`functionFactory.xmlquery_db2();`
	`435`	`+ functionFactory.xmlexists();`
`435`	`436`	`}`
`436`	`437`
`437`	`438`	`@Override`
Original file line number	Diff line number	Diff line change
`@@ -422,6 +422,7 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio`
`422`	`422`	`functionFactory.xmlconcat();`
`423`	`423`	`functionFactory.xmlpi();`
`424`	`424`	`functionFactory.xmlquery_oracle();`
	`425`	`+ functionFactory.xmlexists();`
`425`	`426`	`}`
`426`	`427`
`427`	`428`	`@Override`