HHH-17314 - Add a configuration option to ignore jdbc parameters in native queries

jrenaat · jrenaat · commit 763a70f63303 · 2023-10-23T17:42:00.000+02:00
Signed-off-by: Jan Schatteman &lt;jschatte@redhat.com&gt;
diff --git a/hibernate-core/src/main/java/org/hibernate/boot/internal/SessionFactoryOptionsBuilder.java b/hibernate-core/src/main/java/org/hibernate/boot/internal/SessionFactoryOptionsBuilder.java
@@ -248,6 +248,7 @@ public class SessionFactoryOptionsBuilder implements SessionFactoryOptions {
 	private TimeZone jdbcTimeZone;
 	private final ValueHandlingMode criteriaValueHandlingMode;
 	private final boolean criteriaCopyTreeEnabled;
+	private final boolean nativeJdbcParametersIgnored;
 	private final ImmutableEntityUpdateQueryHandlingMode immutableEntityUpdateQueryHandlingMode;
 	// These two settings cannot be modified from the builder,
 	// in order to maintain consistency.
@@ -551,6 +552,12 @@ else if ( jdbcTimeZoneValue != null ) {
 				jpaBootstrap
 		);
 
+		this.nativeJdbcParametersIgnored = getBoolean(
+				AvailableSettings.NATIVE_IGNORE_JDBC_PARAMETERS,
+				configurationSettings,
+				false
+		);
+
 		// added the boolean parameter in case we want to define some form of "all" as discussed
 		this.jpaCompliance = context.getJpaCompliance();
 
@@ -1145,6 +1152,11 @@ public boolean isCriteriaCopyTreeEnabled() {
 		return criteriaCopyTreeEnabled;
 	}
 
+	@Override
+	public boolean getNativeJdbcParametersIgnored() {
+		return nativeJdbcParametersIgnored;
+	}
+
 	@Override
 	public ImmutableEntityUpdateQueryHandlingMode getImmutableEntityUpdateQueryHandlingMode() {
 		return immutableEntityUpdateQueryHandlingMode;
diff --git a/hibernate-core/src/main/java/org/hibernate/boot/spi/AbstractDelegatingSessionFactoryOptions.java b/hibernate-core/src/main/java/org/hibernate/boot/spi/AbstractDelegatingSessionFactoryOptions.java
@@ -382,6 +382,10 @@ public boolean isCriteriaCopyTreeEnabled() {
 		return delegate.isCriteriaCopyTreeEnabled();
 	}
 
+	public boolean getNativeJdbcParametersIgnored() {
+		return delegate.getNativeJdbcParametersIgnored();
+	}
+
 	@Override
 	public JpaCompliance getJpaCompliance() {
 		return delegate.getJpaCompliance();
diff --git a/hibernate-core/src/main/java/org/hibernate/boot/spi/SessionFactoryOptions.java b/hibernate-core/src/main/java/org/hibernate/boot/spi/SessionFactoryOptions.java
@@ -231,6 +231,13 @@ default boolean isCriteriaCopyTreeEnabled() {
 		return false;
 	}
 
+	/**
+	 * @see org.hibernate.cfg.AvailableSettings#NATIVE_IGNORE_JDBC_PARAMETERS
+	 */
+	default boolean getNativeJdbcParametersIgnored() {
+		return false;
+	}
+
 	JpaCompliance getJpaCompliance();
 
 	boolean isFailOnPaginationOverCollectionFetchEnabled();
diff --git a/hibernate-core/src/main/java/org/hibernate/cfg/QuerySettings.java b/hibernate-core/src/main/java/org/hibernate/cfg/QuerySettings.java
@@ -6,6 +6,7 @@
  */
 package org.hibernate.cfg;
 
+import org.hibernate.boot.spi.SessionFactoryOptions;
 import org.hibernate.query.NullPrecedence;
 import org.hibernate.query.spi.QueryPlan;
 
@@ -124,6 +125,16 @@ public interface QuerySettings {
 	 */
 	String CRITERIA_COPY_TREE = "hibernate.criteria.copy_tree";
 
+	/**
+	 * When set to true, indicates that ordinal parameters (represented by the '?' placeholder) in native queries will be ignored.
+	 * <p>
+	 * By default, this is set to false, i.e. native queries will be checked for ordinal placeholders.
+	 * <p>
+	 *
+	 * @see SessionFactoryOptions#getIgnoreNativeJdbcParameters()
+	 */
+	String NATIVE_IGNORE_JDBC_PARAMETERS = "hibernate.query.native.ignore_jdbc_parameters";
+
 	/**
 	 * When {@linkplain org.hibernate.query.Query#setMaxResults(int) pagination} is used
 	 * in combination with a {@code fetch join} applied to a collection or many-valued
diff --git a/hibernate-core/src/main/java/org/hibernate/engine/query/internal/NativeQueryInterpreterStandardImpl.java b/hibernate-core/src/main/java/org/hibernate/engine/query/internal/NativeQueryInterpreterStandardImpl.java
@@ -21,11 +21,17 @@ public class NativeQueryInterpreterStandardImpl implements NativeQueryInterprete
 	/**
 	 * Singleton access
 	 */
-	public static final NativeQueryInterpreterStandardImpl NATIVE_QUERY_INTERPRETER = new NativeQueryInterpreterStandardImpl();
+	public static final NativeQueryInterpreterStandardImpl NATIVE_QUERY_INTERPRETER = new NativeQueryInterpreterStandardImpl( false );
+
+	private boolean nativeJdbcParametersIgnored;
+
+	public NativeQueryInterpreterStandardImpl(boolean nativeJdbcParametersIgnored) {
+		this.nativeJdbcParametersIgnored = nativeJdbcParametersIgnored;
+	}
 
 	@Override
 	public void recognizeParameters(String nativeQuery, ParameterRecognizer recognizer) {
-		ParameterParser.parse( nativeQuery, recognizer );
+		ParameterParser.parse( nativeQuery, recognizer, nativeJdbcParametersIgnored );
 	}
 
 	@Override
diff --git a/hibernate-core/src/main/java/org/hibernate/engine/query/spi/NativeQueryInterpreterInitiator.java b/hibernate-core/src/main/java/org/hibernate/engine/query/spi/NativeQueryInterpreterInitiator.java
@@ -21,7 +21,7 @@ public class NativeQueryInterpreterInitiator implements SessionFactoryServiceIni
 
 	@Override
 	public NativeQueryInterpreter initiateService(SessionFactoryServiceInitiatorContext context) {
-		return new NativeQueryInterpreterStandardImpl();
+		return new NativeQueryInterpreterStandardImpl( context.getSessionFactoryOptions().getNativeJdbcParametersIgnored() );
 	}
 
 	@Override
diff --git a/hibernate-core/src/main/java/org/hibernate/engine/spi/SessionDelegatorBaseImpl.java b/hibernate-core/src/main/java/org/hibernate/engine/spi/SessionDelegatorBaseImpl.java
@@ -240,6 +240,16 @@ public boolean isCriteriaCopyTreeEnabled() {
 		return delegate.isCriteriaCopyTreeEnabled();
 	}
 
+	@Override
+	public boolean getNativeJdbcParametersIgnored() {
+		return delegate.getNativeJdbcParametersIgnored();
+	}
+
+	@Override
+	public void setNativeJdbcParametersIgnored(boolean nativeJdbcParametersIgnored) {
+		delegate.setNativeJdbcParametersIgnored( nativeJdbcParametersIgnored );
+	}
+
 	@Override
 	public boolean isOpen() {
 		return delegate.isOpen();
diff --git a/hibernate-core/src/main/java/org/hibernate/engine/spi/SharedSessionContractImplementor.java b/hibernate-core/src/main/java/org/hibernate/engine/spi/SharedSessionContractImplementor.java
@@ -381,6 +381,10 @@ default String bestGuessEntityName(Object object, EntityEntry entry) {
 
 	boolean isCriteriaCopyTreeEnabled();
 
+	boolean getNativeJdbcParametersIgnored();
+
+	void setNativeJdbcParametersIgnored(boolean nativeJdbcParametersIgnored);
+
 	/**
 	 * Get the current {@link FlushModeType} for this session.
 	 * <p>
diff --git a/hibernate-core/src/main/java/org/hibernate/engine/spi/SharedSessionDelegatorBaseImpl.java b/hibernate-core/src/main/java/org/hibernate/engine/spi/SharedSessionDelegatorBaseImpl.java
@@ -474,6 +474,16 @@ public boolean isCriteriaCopyTreeEnabled() {
 		return delegate.isCriteriaCopyTreeEnabled();
 	}
 
+	@Override
+	public boolean getNativeJdbcParametersIgnored() {
+		return delegate.getNativeJdbcParametersIgnored();
+	}
+
+	@Override
+	public void setNativeJdbcParametersIgnored(boolean nativeJdbcParametersIgnored) {
+		delegate.setNativeJdbcParametersIgnored( nativeJdbcParametersIgnored );
+	}
+
 	@Override
 	public FlushModeType getFlushMode() {
 		return delegate.getFlushMode();
diff --git a/hibernate-core/src/main/java/org/hibernate/internal/AbstractSharedSessionContract.java b/hibernate-core/src/main/java/org/hibernate/internal/AbstractSharedSessionContract.java
@@ -162,6 +162,8 @@ public abstract class AbstractSharedSessionContract implements SharedSessionCont
 
 	private boolean criteriaCopyTreeEnabled;
 
+	private boolean nativeJdbcParametersIgnored;
+
 	protected boolean closed;
 	protected boolean waitingForAutoClose;
 
@@ -183,6 +185,7 @@ public AbstractSharedSessionContract(SessionFactoryImpl factory, SessionCreation
 		sessionEventsManager = createSessionEventsManager(options);
 		entityNameResolver = new CoordinatingEntityNameResolver( factory, interceptor );
 		setCriteriaCopyTreeEnabled( factory.getSessionFactoryOptions().isCriteriaCopyTreeEnabled() );
+		setNativeJdbcParametersIgnored( factory.getSessionFactoryOptions().getNativeJdbcParametersIgnored() );
 
 		final StatementInspector statementInspector = interpret( options.getStatementInspector() );
 
@@ -701,6 +704,16 @@ public boolean isCriteriaCopyTreeEnabled() {
 		return criteriaCopyTreeEnabled;
 	}
 
+	@Override
+	public boolean getNativeJdbcParametersIgnored() {
+		return nativeJdbcParametersIgnored;
+	}
+
+	@Override
+	public void setNativeJdbcParametersIgnored(boolean nativeJdbcParametersIgnored) {
+		this.nativeJdbcParametersIgnored = nativeJdbcParametersIgnored;
+	}
+
 	// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 	// dynamic HQL handling
 
diff --git a/hibernate-core/src/main/java/org/hibernate/query/sql/internal/NativeQueryImpl.java b/hibernate-core/src/main/java/org/hibernate/query/sql/internal/NativeQueryImpl.java
@@ -173,55 +173,6 @@ else if ( memento.getResultMappingClass() != null ) {
 		);
 	}
 
-	@FunctionalInterface
-	private interface ResultSetMappingHandler {
-		boolean resolveResultSetMapping(
-				ResultSetMapping resultSetMapping,
-				Consumer<String> querySpaceConsumer,
-				ResultSetMappingResolutionContext context);
-	}
-
-	private static ResultSetMapping buildResultSetMapping(
-			String registeredName,
-			boolean isDynamic,
-			SharedSessionContractImplementor session) {
-		return ResultSetMapping.resolveResultSetMapping( registeredName, isDynamic, session.getFactory() );
-	}
-
-	public NativeQueryImpl(
-			NamedNativeQueryMemento memento,
-			Supplier<ResultSetMapping> resultSetMappingCreator,
-			ResultSetMappingHandler resultSetMappingHandler,
-			SharedSessionContractImplementor session) {
-		super( session );
-
-		this.originalSqlString = memento.getOriginalSqlString();
-
-		final ParameterInterpretation parameterInterpretation = resolveParameterInterpretation(
-				originalSqlString,
-				session
-		);
-
-		this.sqlString = parameterInterpretation.getAdjustedSqlString();
-		this.parameterMetadata = parameterInterpretation.toParameterMetadata( session );
-		this.parameterOccurrences = parameterInterpretation.getOrderedParameterOccurrences();
-		this.parameterBindings = QueryParameterBindingsImpl.from( parameterMetadata, session.getFactory() );
-		this.querySpaces = new HashSet<>();
-
-		this.resultSetMapping = resultSetMappingCreator.get();
-
-		//noinspection UnnecessaryLocalVariable
-		final boolean appliedAnyResults = resultSetMappingHandler.resolveResultSetMapping(
-				resultSetMapping,
-				querySpaces::add,
-				this
-		);
-
-		this.resultMappingSuppliedToCtor = appliedAnyResults;
-
-		applyOptions( memento );
-	}
-
 	/**
 	 * Constructs a NativeQueryImpl given a sql query defined in the mappings.
 	 */
@@ -306,6 +257,40 @@ public NativeQueryImpl(
 
 	}
 
+	public NativeQueryImpl(
+			NamedNativeQueryMemento memento,
+			Supplier<ResultSetMapping> resultSetMappingCreator,
+			ResultSetMappingHandler resultSetMappingHandler,
+			SharedSessionContractImplementor session) {
+		super( session );
+
+		this.originalSqlString = memento.getOriginalSqlString();
+
+		final ParameterInterpretation parameterInterpretation = resolveParameterInterpretation(
+				originalSqlString,
+				session
+		);
+
+		this.sqlString = parameterInterpretation.getAdjustedSqlString();
+		this.parameterMetadata = parameterInterpretation.toParameterMetadata( session );
+		this.parameterOccurrences = parameterInterpretation.getOrderedParameterOccurrences();
+		this.parameterBindings = QueryParameterBindingsImpl.from( parameterMetadata, session.getFactory() );
+		this.querySpaces = new HashSet<>();
+
+		this.resultSetMapping = resultSetMappingCreator.get();
+
+		//noinspection UnnecessaryLocalVariable
+		final boolean appliedAnyResults = resultSetMappingHandler.resolveResultSetMapping(
+				resultSetMapping,
+				querySpaces::add,
+				this
+		);
+
+		this.resultMappingSuppliedToCtor = appliedAnyResults;
+
+		applyOptions( memento );
+	}
+
 	public NativeQueryImpl(
 			String sqlString,
 			NamedResultSetMappingMemento resultSetMappingMemento,
@@ -331,6 +316,37 @@ public NativeQueryImpl(
 		this.resultMappingSuppliedToCtor = true;
 	}
 
+	public NativeQueryImpl(String sqlString, SharedSessionContractImplementor session) {
+		super( session );
+
+		this.querySpaces = new HashSet<>();
+
+		final ParameterInterpretation parameterInterpretation = resolveParameterInterpretation( sqlString, session );
+		this.originalSqlString = sqlString;
+		this.sqlString = parameterInterpretation.getAdjustedSqlString();
+		this.parameterMetadata = parameterInterpretation.toParameterMetadata( session );
+		this.parameterOccurrences = parameterInterpretation.getOrderedParameterOccurrences();
+		this.parameterBindings = QueryParameterBindingsImpl.from( parameterMetadata, session.getFactory() );
+
+		this.resultSetMapping = ResultSetMapping.resolveResultSetMapping( sqlString, true, session.getFactory() );
+		this.resultMappingSuppliedToCtor = false;
+	}
+
+	@FunctionalInterface
+	private interface ResultSetMappingHandler {
+		boolean resolveResultSetMapping(
+				ResultSetMapping resultSetMapping,
+				Consumer<String> querySpaceConsumer,
+				ResultSetMappingResolutionContext context);
+	}
+
+	private static ResultSetMapping buildResultSetMapping(
+			String registeredName,
+			boolean isDynamic,
+			SharedSessionContractImplementor session) {
+		return ResultSetMapping.resolveResultSetMapping( registeredName, isDynamic, session.getFactory() );
+	}
+
 	public List<ParameterOccurrence> getParameterOccurrences() {
 		return parameterOccurrences;
 	}
@@ -374,22 +390,6 @@ protected void applyOptions(NamedNativeQueryMemento memento) {
 		// todo (6.0) : query returns
 	}
 
-	public NativeQueryImpl(String sqlString, SharedSessionContractImplementor session) {
-		super( session );
-
-		this.querySpaces = new HashSet<>();
-
-		final ParameterInterpretation parameterInterpretation = resolveParameterInterpretation( sqlString, session );
-		this.originalSqlString = sqlString;
-		this.sqlString = parameterInterpretation.getAdjustedSqlString();
-		this.parameterMetadata = parameterInterpretation.toParameterMetadata( session );
-		this.parameterOccurrences = parameterInterpretation.getOrderedParameterOccurrences();
-		this.parameterBindings = QueryParameterBindingsImpl.from( parameterMetadata, session.getFactory() );
-
-		this.resultSetMapping = ResultSetMapping.resolveResultSetMapping( sqlString, true, session.getFactory() );
-		this.resultMappingSuppliedToCtor = false;
-	}
-
 	private IllegalArgumentException buildIncompatibleException(Class<?> resultClass, Class<?> actualResultClass) {
 		final String resultClassName = resultClass.getName();
 		final String actualResultClassName = actualResultClass.getName();
diff --git a/hibernate-core/src/main/java/org/hibernate/query/sql/internal/ParameterParser.java b/hibernate-core/src/main/java/org/hibernate/query/sql/internal/ParameterParser.java
@@ -47,9 +47,10 @@ private ParameterParser() {
 	 *
 	 * @param sqlString The string to be parsed/tokenized.
 	 * @param recognizer The thing which handles recognition events.
+	 * @param nativeJdbcParametersIgnored Whether to ignore ordinal parameters in native queries or not.
 	 * @throws QueryException Indicates unexpected parameter conditions.
 	 */
-	public static void parse(String sqlString, ParameterRecognizer recognizer) throws QueryException {
+	public static void parse(String sqlString, ParameterRecognizer recognizer, boolean nativeJdbcParametersIgnored) throws QueryException {
 		checkIsNotAFunctionCall( sqlString );
 		final int stringLength = sqlString.length();
 
@@ -163,7 +164,9 @@ else if ( c == '?' ) {
 						}
 					}
 					else {
-						recognizer.ordinalParameter( indx );
+						if ( !nativeJdbcParametersIgnored ) {
+							recognizer.ordinalParameter( indx );
+						}
 					}
 				}
 				else {
@@ -175,6 +178,10 @@ else if ( c == '?' ) {
 		recognizer.complete();
 	}
 
+	public static void parse(String sqlString, ParameterRecognizer recognizer) throws QueryException {
+		parse( sqlString, recognizer, false );
+	}
+
 	private static void checkIsNotAFunctionCall(String sqlString) {
 		final String trimmed = sqlString.trim();
 		if ( !( trimmed.startsWith( "{" ) && trimmed.endsWith( "}" ) ) ) {
diff --git a/hibernate-core/src/main/java/org/hibernate/query/sql/spi/ParameterRecognizer.java b/hibernate-core/src/main/java/org/hibernate/query/sql/spi/ParameterRecognizer.java
@@ -7,7 +7,7 @@
 package org.hibernate.query.sql.spi;
 
 /**
- * Defines the "callback" the process of recognizing native query parameters.
+ * Defines the "callback" process of recognizing native query parameters.
  *
  * @see org.hibernate.engine.query.spi.NativeQueryInterpreter#recognizeParameters
  */
diff --git a/hibernate-core/src/test/java/org/hibernate/orm/test/query/sql/NativeQueryParameterTests.java b/hibernate-core/src/test/java/org/hibernate/orm/test/query/sql/NativeQueryParameterTests.java
diff --git a/hibernate-core/src/test/java/org/hibernate/orm/test/query/sql/ParameterParserTest.java b/hibernate-core/src/test/java/org/hibernate/orm/test/query/sql/ParameterParserTest.java
diff --git a/tooling/metamodel-generator/src/main/java/org/hibernate/jpamodelgen/validation/MockSessionFactory.java b/tooling/metamodel-generator/src/main/java/org/hibernate/jpamodelgen/validation/MockSessionFactory.java

Original file line number	Diff line number	Diff line change
`@@ -21,7 +21,7 @@ public class NativeQueryInterpreterInitiator implements SessionFactoryServiceIni`
`21`	`21`
`22`	`22`	`@Override`
`23`	`23`	`public NativeQueryInterpreter initiateService(SessionFactoryServiceInitiatorContext context) {`
`24`		`- return new NativeQueryInterpreterStandardImpl();`
	`24`	`+ return new NativeQueryInterpreterStandardImpl( context.getSessionFactoryOptions().getNativeJdbcParametersIgnored() );`
`25`	`25`	`}`
`26`	`26`
`27`	`27`	`@Override`