HHH-18497 Add xmlpi function

beikov · beikov · commit 574959a591f4 · 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
@@ -2175,6 +2175,7 @@ it is necessary to enable the `hibernate.query.hql.xml_functions_enabled` config
 | `xmlcomment()` | Constructs an XML comment from the single argument
 | `xmlforest()` | Constructs an XML forest from the arguments
 | `xmlconcat()` | Concatenates multiple XML fragments to each other
+| `xmlpi()` | Constructs an XML processing instruction
 |===
 
 
@@ -2266,6 +2267,39 @@ include::{xml-example-dir-hql}/XmlConcatTest.java[tags=hql-xmlconcat-example]
 
 WARNING: SAP HANA, MySQL, MariaDB and HSQLDB do not support this function.
 
+[[hql-xmlpi-function]]
+===== `xmlpi()`
+
+Constructs an XML processing instruction from the arguments.
+
+[[hql-xmlpi-bnf]]
+[source, antlrv4, indent=0]
+----
+include::{extrasdir}/xmlpi_bnf.txt[]
+----
+
+The identifier represents the XML processing instruction name and can be quoted by using backticks.
+
+[[hql-xmlpi-example]]
+====
+[source, java, indent=0]
+----
+include::{xml-example-dir-hql}/XmlPiTest.java[tags=hql-xmlpi-example]
+----
+====
+
+The optional second argument represents the processing instruction content.
+
+[[hql-xmlpi-content-example]]
+====
+[source, java, indent=0]
+----
+include::{xml-example-dir-hql}/XmlPiTest.java[tags=hql-xmlpi-content-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/xmlpi_bnf.txt b/documentation/src/main/asciidoc/userguide/chapters/query/hql/extras/xmlpi_bnf.txt
@@ -0,0 +1 @@
+"xmlpi(name " identifier ("," expressionOrPredicate)? ")"
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
@@ -445,6 +445,7 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio
 		functionFactory.xmlcomment();
 		functionFactory.xmlforest();
 		functionFactory.xmlconcat();
+		functionFactory.xmlpi();
 	}
 
 	@Override
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
@@ -422,6 +422,7 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio
 			functionFactory.xmlcomment();
 			functionFactory.xmlforest_h2();
 			functionFactory.xmlconcat_h2();
+			functionFactory.xmlpi_h2();
 		}
 		else {
 			functionFactory.listagg_groupConcat();
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
@@ -330,6 +330,7 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio
 		functionFactory.xmlcomment();
 		functionFactory.xmlforest();
 		functionFactory.xmlconcat();
+		functionFactory.xmlpi();
 	}
 
 	@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
@@ -673,6 +673,7 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio
 		functionFactory.xmlcomment();
 		functionFactory.xmlforest();
 		functionFactory.xmlconcat();
+		functionFactory.xmlpi();
 
 		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
@@ -417,6 +417,7 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio
 		functionFactory.xmlcomment_sqlserver();
 		functionFactory.xmlforest_sqlserver();
 		functionFactory.xmlconcat_sqlserver();
+		functionFactory.xmlpi_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
@@ -333,6 +333,7 @@ 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];
 XMLFOREST			: [xX] [mM] [lL] [fF] [oO] [rR] [eE] [sS] [tT];
+XMLPI				: [xX] [mM] [lL] [pP] [iI];
 YEAR				: [yY] [eE] [aA] [rR];
 ZONED				: [zZ] [oO] [nN] [eE] [dD];
 
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
@@ -1720,6 +1720,7 @@ jsonUniqueKeysClause
 xmlFunction
 	: xmlelementFunction
 	| xmlforestFunction
+	| xmlpiFunction
 	;
 
 /**
@@ -1743,6 +1744,13 @@ xmlforestFunction
 	: XMLFOREST LEFT_PAREN expressionOrPredicate (AS identifier)? (COMMA expressionOrPredicate (AS identifier)?)* RIGHT_PAREN
 	;
 
+/**
+ * The 'xmlpi()' function
+ */
+xmlpiFunction
+	: XMLPI LEFT_PAREN NAME identifier (COMMA expression)? RIGHT_PAREN
+	;
+
 /**
  * Support for "soft" keywords which may be used as identifiers
  *
@@ -1952,6 +1960,7 @@ xmlforestFunction
 	| XMLATTRIBUTES
 	| XMLELEMENT
 	| XMLFOREST
+	| XMLPI
 	| YEAR
 	| ZONED) {
 		logUseOfReservedWordAsIdentifier( getCurrentToken() );
diff --git a/hibernate-core/src/main/java/org/hibernate/dialect/DB2Dialect.java b/hibernate-core/src/main/java/org/hibernate/dialect/DB2Dialect.java
@@ -430,6 +430,7 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio
 		functionFactory.xmlcomment();
 		functionFactory.xmlforest();
 		functionFactory.xmlconcat();
+		functionFactory.xmlpi();
 	}
 
 	@Override
diff --git a/hibernate-core/src/main/java/org/hibernate/dialect/H2Dialect.java b/hibernate-core/src/main/java/org/hibernate/dialect/H2Dialect.java
@@ -357,6 +357,7 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio
 		functionFactory.xmlcomment();
 		functionFactory.xmlforest_h2();
 		functionFactory.xmlconcat_h2();
+		functionFactory.xmlpi_h2();
 	}
 
 	/**
diff --git a/hibernate-core/src/main/java/org/hibernate/dialect/OracleDialect.java b/hibernate-core/src/main/java/org/hibernate/dialect/OracleDialect.java
@@ -420,6 +420,7 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio
 		functionFactory.xmlcomment();
 		functionFactory.xmlforest();
 		functionFactory.xmlconcat();
+		functionFactory.xmlpi();
 	}
 
 	@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
@@ -634,6 +634,7 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio
 		functionFactory.xmlcomment();
 		functionFactory.xmlforest();
 		functionFactory.xmlconcat();
+		functionFactory.xmlpi();
 
 		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
@@ -435,6 +435,7 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio
 		functionFactory.xmlcomment_sqlserver();
 		functionFactory.xmlforest_sqlserver();
 		functionFactory.xmlconcat_sqlserver();
+		functionFactory.xmlpi_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/CommonFunctionFactory.java b/hibernate-core/src/main/java/org/hibernate/dialect/function/CommonFunctionFactory.java
@@ -156,12 +156,15 @@
 import org.hibernate.dialect.function.xml.H2XmlConcatFunction;
 import org.hibernate.dialect.function.xml.H2XmlElementFunction;
 import org.hibernate.dialect.function.xml.H2XmlForestFunction;
+import org.hibernate.dialect.function.xml.H2XmlPiFunction;
 import org.hibernate.dialect.function.xml.SQLServerXmlConcatFunction;
 import org.hibernate.dialect.function.xml.SQLServerXmlElementFunction;
 import org.hibernate.dialect.function.xml.SQLServerXmlForestFunction;
+import org.hibernate.dialect.function.xml.SQLServerXmlPiFunction;
 import org.hibernate.dialect.function.xml.XmlConcatFunction;
 import org.hibernate.dialect.function.xml.XmlElementFunction;
 import org.hibernate.dialect.function.xml.XmlForestFunction;
+import org.hibernate.dialect.function.xml.XmlPiFunction;
 import org.hibernate.query.sqm.function.SqmFunctionRegistry;
 import org.hibernate.query.sqm.produce.function.ArgumentTypesValidator;
 import org.hibernate.query.sqm.produce.function.FunctionParameterType;
@@ -4191,4 +4194,25 @@ public void xmlconcat_h2() {
 	public void xmlconcat_sqlserver() {
 		functionRegistry.register( "xmlconcat", new SQLServerXmlConcatFunction( typeConfiguration ) );
 	}
+
+	/**
+	 * Standard xmlpi() function
+	 */
+	public void xmlpi() {
+		functionRegistry.register( "xmlpi", new XmlPiFunction( typeConfiguration ) );
+	}
+
+	/**
+	 * H2 xmlpi() function
+	 */
+	public void xmlpi_h2() {
+		functionRegistry.register( "xmlpi", new H2XmlPiFunction( typeConfiguration ) );
+	}
+
+	/**
+	 * SQL Server xmlpi() function
+	 */
+	public void xmlpi_sqlserver() {
+		functionRegistry.register( "xmlpi", new SQLServerXmlPiFunction( typeConfiguration ) );
+	}
 }
diff --git a/hibernate-core/src/main/java/org/hibernate/dialect/function/xml/H2XmlPiFunction.java b/hibernate-core/src/main/java/org/hibernate/dialect/function/xml/H2XmlPiFunction.java
@@ -0,0 +1,44 @@
+/*
+ * 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.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.Literal;
+import org.hibernate.type.spi.TypeConfiguration;
+
+/**
+ * H2 xmlpi function.
+ */
+public class H2XmlPiFunction extends XmlPiFunction {
+
+	public H2XmlPiFunction(TypeConfiguration typeConfiguration) {
+		super( typeConfiguration );
+	}
+
+	@Override
+	public void render(
+			SqlAppender sqlAppender,
+			List<? extends SqlAstNode> sqlAstArguments,
+			ReturnableType<?> returnType,
+			SqlAstTranslator<?> walker) {
+		sqlAppender.appendSql( "'<?" );
+		final Literal literal = (Literal) sqlAstArguments.get( 0 );
+		sqlAppender.appendSql( (String) literal.getLiteralValue() );
+
+		if ( sqlAstArguments.size() > 1 ) {
+			sqlAppender.appendSql( " '||" );
+			sqlAstArguments.get( 1 ).accept( walker );
+			sqlAppender.appendSql( "||'?>'" );
+		}
+		else {
+			sqlAppender.appendSql( "?>'" );
+		}
+	}
+}
diff --git a/hibernate-core/src/main/java/org/hibernate/dialect/function/xml/SQLServerXmlPiFunction.java b/hibernate-core/src/main/java/org/hibernate/dialect/function/xml/SQLServerXmlPiFunction.java
@@ -0,0 +1,45 @@
+/*
+ * 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.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.Literal;
+import org.hibernate.type.spi.TypeConfiguration;
+
+/**
+ * SQL Server xmlpi function.
+ */
+public class SQLServerXmlPiFunction extends XmlPiFunction {
+
+	public SQLServerXmlPiFunction(TypeConfiguration typeConfiguration) {
+		super( typeConfiguration );
+	}
+
+	@Override
+	public void render(
+			SqlAppender sqlAppender,
+			List<? extends SqlAstNode> sqlAstArguments,
+			ReturnableType<?> returnType,
+			SqlAstTranslator<?> walker) {
+		sqlAppender.appendSql( "cast('<?" );
+		final Literal literal = (Literal) sqlAstArguments.get( 0 );
+		sqlAppender.appendSql( (String) literal.getLiteralValue() );
+
+		if ( sqlAstArguments.size() > 1 ) {
+			sqlAppender.appendSql( " '+" );
+			sqlAstArguments.get( 1 ).accept( walker );
+			sqlAppender.appendSql( "+'?>'" );
+		}
+		else {
+			sqlAppender.appendSql( "?>'" );
+		}
+		sqlAppender.appendSql( " as xml)" );
+	}
+}
diff --git a/hibernate-core/src/main/java/org/hibernate/dialect/function/xml/XmlConcatFunction.java b/hibernate-core/src/main/java/org/hibernate/dialect/function/xml/XmlConcatFunction.java
@@ -22,7 +22,7 @@
 import static org.hibernate.query.sqm.produce.function.FunctionParameterType.XML;
 
 /**
- * Standard XmlConcatFunction function.
+ * Standard xmlconcat function.
  */
 public class XmlConcatFunction extends AbstractSqmSelfRenderingFunctionDescriptor {
 
@@ -31,7 +31,7 @@ public XmlConcatFunction(TypeConfiguration typeConfiguration) {
 				"xmlconcat",
 				FunctionKind.NORMAL,
 				StandardArgumentsValidators.composite(
-						new ArgumentTypesValidator( StandardArgumentsValidators.min( 1 ), XML )
+						new ArgumentTypesValidator( StandardArgumentsValidators.min( 2 ), XML )
 				),
 				StandardFunctionReturnTypeResolvers.invariant(
 						typeConfiguration.getBasicTypeRegistry().resolve( String.class, SqlTypes.SQLXML )
diff --git a/hibernate-core/src/main/java/org/hibernate/dialect/function/xml/XmlForestFunction.java b/hibernate-core/src/main/java/org/hibernate/dialect/function/xml/XmlForestFunction.java
@@ -26,7 +26,7 @@
 import static java.lang.Character.isLetterOrDigit;
 
 /**
- * Standard XmlForestFunction function.
+ * Standard xmlforest function.
  */
 public class XmlForestFunction extends AbstractSqmSelfRenderingFunctionDescriptor {
 
diff --git a/hibernate-core/src/main/java/org/hibernate/dialect/function/xml/XmlPiFunction.java b/hibernate-core/src/main/java/org/hibernate/dialect/function/xml/XmlPiFunction.java
@@ -0,0 +1,60 @@
+/*
+ * 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.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.Literal;
+import org.hibernate.type.SqlTypes;
+import org.hibernate.type.spi.TypeConfiguration;
+
+import static org.hibernate.query.sqm.produce.function.FunctionParameterType.ANY;
+import static org.hibernate.query.sqm.produce.function.FunctionParameterType.STRING;
+
+/**
+ * Standard xmlpi function.
+ */
+public class XmlPiFunction extends AbstractSqmSelfRenderingFunctionDescriptor {
+
+	public XmlPiFunction(TypeConfiguration typeConfiguration) {
+		super(
+				"xmlpi",
+				FunctionKind.NORMAL,
+				StandardArgumentsValidators.composite(
+						new ArgumentTypesValidator( StandardArgumentsValidators.between( 1, 2 ), STRING, STRING )
+				),
+				StandardFunctionReturnTypeResolvers.invariant(
+						typeConfiguration.getBasicTypeRegistry().resolve( String.class, SqlTypes.SQLXML )
+				),
+				StandardFunctionArgumentTypeResolvers.invariant( typeConfiguration, ANY, STRING )
+		);
+	}
+
+	@Override
+	public void render(
+			SqlAppender sqlAppender,
+			List<? extends SqlAstNode> sqlAstArguments,
+			ReturnableType<?> returnType,
+			SqlAstTranslator<?> walker) {
+		sqlAppender.appendSql( "xmlpi(name " );
+		final Literal literal = (Literal) sqlAstArguments.get( 0 );
+		sqlAppender.appendDoubleQuoteEscapedString( (String) literal.getLiteralValue() );
+		if ( sqlAstArguments.size() > 1 ) {
+			sqlAppender.appendSql( ',' );
+			sqlAstArguments.get( 1 ).accept( walker );
+		}
+		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
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
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
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
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
diff --git a/hibernate-core/src/test/java/org/hibernate/orm/test/function/xml/XmlPiTest.java b/hibernate-core/src/test/java/org/hibernate/orm/test/function/xml/XmlPiTest.java
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`	`+"xmlpi(name " identifier ("," expressionOrPredicate)? ")"`
Original file line number	Diff line number	Diff line change
`@@ -445,6 +445,7 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio`
`445`	`445`	`functionFactory.xmlcomment();`
`446`	`446`	`functionFactory.xmlforest();`
`447`	`447`	`functionFactory.xmlconcat();`
	`448`	`+ functionFactory.xmlpi();`
`448`	`449`	`}`
`449`	`450`
`450`	`451`	`@Override`
Original file line number	Diff line number	Diff line change
`@@ -422,6 +422,7 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio`
`422`	`422`	`functionFactory.xmlcomment();`
`423`	`423`	`functionFactory.xmlforest_h2();`
`424`	`424`	`functionFactory.xmlconcat_h2();`
	`425`	`+ functionFactory.xmlpi_h2();`
`425`	`426`	`}`
`426`	`427`	`else {`
`427`	`428`	`functionFactory.listagg_groupConcat();`
Original file line number	Diff line number	Diff line change
`@@ -330,6 +330,7 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio`
`330`	`330`	`functionFactory.xmlcomment();`
`331`	`331`	`functionFactory.xmlforest();`
`332`	`332`	`functionFactory.xmlconcat();`
	`333`	`+ functionFactory.xmlpi();`
`333`	`334`	`}`
`334`	`335`
`335`	`336`	`@Override`
Original file line number	Diff line number	Diff line change
`@@ -430,6 +430,7 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio`
`430`	`430`	`functionFactory.xmlcomment();`
`431`	`431`	`functionFactory.xmlforest();`
`432`	`432`	`functionFactory.xmlconcat();`
	`433`	`+ functionFactory.xmlpi();`
`433`	`434`	`}`
`434`	`435`
`435`	`436`	`@Override`