HHH-16283 refactor to move marker config into QueryOptions

nathan.xu · nathan.xu · commit f03ed8b00270 · 2024-09-15T23:38:14.000-04:00
diff --git a/hibernate-core/src/main/java/org/hibernate/dialect/pagination/LimitHandler.java b/hibernate-core/src/main/java/org/hibernate/dialect/pagination/LimitHandler.java
@@ -8,11 +8,9 @@
 
 import java.sql.PreparedStatement;
 import java.sql.SQLException;
-import java.util.function.Supplier;
 
 import org.hibernate.query.spi.Limit;
 import org.hibernate.query.spi.QueryOptions;
-import org.hibernate.sql.ast.spi.ParameterMarkerStrategy;
 
 /**
  * Contract defining dialect-specific limit and offset handling.
@@ -49,10 +47,6 @@ default String processSql(String sql, Limit limit, QueryOptions queryOptions) {
 		return processSql( sql, limit );
 	}
 
-	default String processSql(String sql, Limit limit, QueryOptions queryOptions, Supplier<String> parameterMarkerSupplier) {
-		return processSql( sql, limit, queryOptions );
-	}
-
 	int bindLimitParametersAtStartOfQuery(Limit limit, PreparedStatement statement, int index) throws SQLException;
 
 	int bindLimitParametersAtEndOfQuery(Limit limit, PreparedStatement statement, int index) throws SQLException;
diff --git a/hibernate-core/src/main/java/org/hibernate/dialect/pagination/OffsetFetchLimitHandler.java b/hibernate-core/src/main/java/org/hibernate/dialect/pagination/OffsetFetchLimitHandler.java
@@ -29,12 +29,7 @@ public OffsetFetchLimitHandler(boolean variableLimit) {
 	}
 
 	@Override
-	public String processSql(String sql, Limit limit) {
-		return processSql( sql, limit, null, () -> "?" );
-	}
-
-	@Override
-	public String processSql(String sql, Limit limit, QueryOptions queryOptions, Supplier<String> parameterMarkerSupplier) {
+	public String processSql(String sql, Limit limit, QueryOptions queryOptions) {
 
 		boolean hasFirstRow = hasFirstRow(limit);
 		boolean hasMaxRows = hasMaxRows(limit);
@@ -47,6 +42,10 @@ public String processSql(String sql, Limit limit, QueryOptions queryOptions, Sup
 
 		begin(sql, offsetFetch, hasFirstRow, hasMaxRows);
 
+		Supplier<String> parameterMarkerSupplier = ( queryOptions == null || queryOptions.getLimitHandlerParameterMarkerSupplier() == null )
+				? () -> "?"
+				: queryOptions.getLimitHandlerParameterMarkerSupplier();
+
 		if ( hasFirstRow ) {
 			offsetFetch.append( " offset " );
 			if ( supportsVariableLimit() ) {
diff --git a/hibernate-core/src/main/java/org/hibernate/query/internal/QueryOptionsImpl.java b/hibernate-core/src/main/java/org/hibernate/query/internal/QueryOptionsImpl.java
@@ -11,6 +11,7 @@
 import java.util.HashSet;
 import java.util.List;
 import java.util.Set;
+import java.util.function.Supplier;
 
 import jakarta.persistence.CacheRetrieveMode;
 import jakarta.persistence.CacheStoreMode;
@@ -54,6 +55,17 @@ public class QueryOptionsImpl implements MutableQueryOptions, AppliedGraph {
 	private Set<String> enabledFetchProfiles;
 	private Set<String> disabledFetchProfiles;
 
+	@Nullable
+	private final Supplier<String> limitHandlerParameterMarkerSupplier;
+
+	public QueryOptionsImpl() {
+		this( null );
+	}
+
+	public QueryOptionsImpl(Supplier<String> limitHandlerParameterMarkerSupplier) {
+		this.limitHandlerParameterMarkerSupplier = limitHandlerParameterMarkerSupplier;
+	}
+
 	@Override
 	public Integer getTimeout() {
 		return timeout;
@@ -257,4 +269,9 @@ public AppliedGraph getAppliedGraph() {
 	public @Nullable GraphSemantic getSemantic() {
 		return graphSemantic;
 	}
+
+	@Override
+	public @Nullable Supplier<String> getLimitHandlerParameterMarkerSupplier() {
+		return this.limitHandlerParameterMarkerSupplier;
+	}
 }
diff --git a/hibernate-core/src/main/java/org/hibernate/query/spi/QueryOptions.java b/hibernate-core/src/main/java/org/hibernate/query/spi/QueryOptions.java
@@ -9,6 +9,7 @@
 import java.sql.Statement;
 import java.util.List;
 import java.util.Set;
+import java.util.function.Supplier;
 
 import jakarta.persistence.CacheRetrieveMode;
 import jakarta.persistence.CacheStoreMode;
@@ -195,6 +196,10 @@ default ListResultsConsumer.UniqueSemantic getUniqueSemantic(){
 		return null;
 	}
 
+	default Supplier<String> getLimitHandlerParameterMarkerSupplier() {
+		return () -> "?";
+	}
+
 	/**
 	 * Provide singleton access for frequently needed options:
 	 */
diff --git a/hibernate-core/src/main/java/org/hibernate/query/sql/internal/NativeNonSelectQueryPlanImpl.java b/hibernate-core/src/main/java/org/hibernate/query/sql/internal/NativeNonSelectQueryPlanImpl.java
@@ -16,8 +16,8 @@
 import org.hibernate.query.spi.DomainQueryExecutionContext;
 import org.hibernate.query.spi.NonSelectQueryPlan;
 import org.hibernate.query.spi.QueryParameterBindings;
+import org.hibernate.query.sql.spi.NativeQueryPlan;
 import org.hibernate.query.sql.spi.ParameterOccurrence;
-import org.hibernate.query.sqm.internal.SqmJdbcExecutionContextAdapter;
 import org.hibernate.sql.exec.internal.JdbcParameterBindingsImpl;
 import org.hibernate.sql.exec.spi.JdbcOperationQueryMutation;
 import org.hibernate.sql.exec.spi.JdbcOperationQueryMutationNative;
@@ -27,7 +27,7 @@
 /**
  * @author Steve Ebersole
  */
-public class NativeNonSelectQueryPlanImpl implements NonSelectQueryPlan {
+public class NativeNonSelectQueryPlanImpl implements NonSelectQueryPlan, NativeQueryPlan {
 	private final String sql;
 	private final Set<String> affectedTableNames;
 
@@ -81,7 +81,7 @@ public int executeUpdate(DomainQueryExecutionContext executionContext) {
 						.getStatementPreparer()
 						.prepareStatement( sql ),
 				(integer, preparedStatement) -> {},
-				SqmJdbcExecutionContextAdapter.usingLockingAndPaging( executionContext )
+				getSqmJdbcExecutionContext( executionContext, jdbcParameterBindings )
 		);
 	}
 }
diff --git a/hibernate-core/src/main/java/org/hibernate/query/sql/internal/NativeSelectQueryPlanImpl.java b/hibernate-core/src/main/java/org/hibernate/query/sql/internal/NativeSelectQueryPlanImpl.java
@@ -22,7 +22,6 @@
 import org.hibernate.query.spi.ScrollableResultsImplementor;
 import org.hibernate.query.sql.spi.NativeSelectQueryPlan;
 import org.hibernate.query.sql.spi.ParameterOccurrence;
-import org.hibernate.query.sqm.internal.SqmJdbcExecutionContextAdapter;
 import org.hibernate.sql.exec.internal.JdbcParameterBindingsImpl;
 import org.hibernate.sql.exec.spi.JdbcOperationQuerySelect;
 import org.hibernate.sql.exec.spi.JdbcParameterBinder;
@@ -92,7 +91,7 @@ public <T> T executeQuery(DomainQueryExecutionContext executionContext, ResultsC
 		return executionContext.getSession().getJdbcServices().getJdbcSelectExecutor().executeQuery(
 				jdbcSelect,
 				jdbcParameterBindings,
-				SqmJdbcExecutionContextAdapter.usingLockingAndPaging( executionContext ),
+				getSqmJdbcExecutionContext( executionContext, jdbcParameterBindings ),
 				null,
 				null,
 				-1,
@@ -135,7 +134,7 @@ public List<R> performList(DomainQueryExecutionContext executionContext) {
 		return executionContext.getSession().getJdbcServices().getJdbcSelectExecutor().list(
 				jdbcSelect,
 				jdbcParameterBindings,
-				SqmJdbcExecutionContextAdapter.usingLockingAndPaging( executionContext ),
+				getSqmJdbcExecutionContext( executionContext, jdbcParameterBindings ),
 				null,
 				queryOptions.getUniqueSemantic() == null ?
 						ListResultsConsumer.UniqueSemantic.NEVER :
@@ -179,7 +178,7 @@ public ScrollableResultsImplementor<R> performScroll(ScrollMode scrollMode, Doma
 				jdbcSelect,
 				scrollMode,
 				jdbcParameterBindings,
-				SqmJdbcExecutionContextAdapter.usingLockingAndPaging( executionContext ),
+				getSqmJdbcExecutionContext( executionContext, jdbcParameterBindings ),
 				null,
 				-1
 		);
diff --git a/hibernate-core/src/main/java/org/hibernate/query/sql/spi/NativeQueryPlan.java b/hibernate-core/src/main/java/org/hibernate/query/sql/spi/NativeQueryPlan.java
@@ -6,8 +6,19 @@
  */
 package org.hibernate.query.sql.spi;
 
+import java.util.function.Supplier;
+
+import org.hibernate.internal.util.MutableInteger;
 import org.hibernate.query.NativeQuery;
+import org.hibernate.query.spi.DelegatingQueryOptions;
+import org.hibernate.query.spi.DomainQueryExecutionContext;
+import org.hibernate.query.spi.QueryOptions;
 import org.hibernate.query.spi.QueryPlan;
+import org.hibernate.query.sqm.internal.SqmJdbcExecutionContextAdapter;
+import org.hibernate.sql.ast.spi.ParameterMarkerStrategy;
+import org.hibernate.sql.exec.spi.ExecutionContext;
+import org.hibernate.sql.exec.spi.JdbcParameterBindings;
+import org.hibernate.type.descriptor.jdbc.IntegerJdbcType;
 
 /**
  * Specialization of {@link QueryPlan} for {@link NativeQuery}
@@ -16,4 +27,25 @@
  * @author Steve Ebersole
  */
 public interface NativeQueryPlan extends QueryPlan {
+
+	default ExecutionContext getSqmJdbcExecutionContext(DomainQueryExecutionContext executionContext, JdbcParameterBindings jdbcParameterBindings) {
+		final ParameterMarkerStrategy parameterMarkerStrategy = executionContext.getSession().getFactory().getServiceRegistry().getService(
+				ParameterMarkerStrategy.class );
+		final QueryOptions queryOptions;
+		if (parameterMarkerStrategy != null) {
+			final MutableInteger parameterPosition = new MutableInteger( jdbcParameterBindings.getBindings().size() );
+			queryOptions = new DelegatingQueryOptions( executionContext.getQueryOptions() ) {
+				@Override
+				public Supplier<String> getLimitHandlerParameterMarkerSupplier() {
+					return () -> parameterMarkerStrategy.createMarker(
+							parameterPosition.incrementAndGet(),
+							IntegerJdbcType.INSTANCE
+					);
+				}
+			};
+		} else {
+			queryOptions = executionContext.getQueryOptions();
+		}
+		return SqmJdbcExecutionContextAdapter.usingLockingAndPaging( executionContext, queryOptions );
+	}
 }
diff --git a/hibernate-core/src/main/java/org/hibernate/query/sqm/internal/SqmJdbcExecutionContextAdapter.java b/hibernate-core/src/main/java/org/hibernate/query/sqm/internal/SqmJdbcExecutionContextAdapter.java
@@ -33,6 +33,10 @@ public static SqmJdbcExecutionContextAdapter usingLockingAndPaging(DomainQueryEx
 		return new SqmJdbcExecutionContextAdapter( sqmExecutionContext, sqmExecutionContext.getQueryOptions() );
 	}
 
+	public static SqmJdbcExecutionContextAdapter usingLockingAndPaging(DomainQueryExecutionContext sqmExecutionContext, QueryOptions queryOptions) {
+		return new SqmJdbcExecutionContextAdapter( sqmExecutionContext, queryOptions );
+	}
+
 	private final DomainQueryExecutionContext sqmExecutionContext;
 	private final QueryOptions queryOptions;
 
diff --git a/hibernate-core/src/main/java/org/hibernate/sql/results/jdbc/internal/DeferredResultSetAccess.java b/hibernate-core/src/main/java/org/hibernate/sql/results/jdbc/internal/DeferredResultSetAccess.java
@@ -24,7 +24,6 @@
 import org.hibernate.event.spi.HibernateMonitoringEvent;
 import org.hibernate.internal.CoreLogging;
 import org.hibernate.internal.CoreMessageLogger;
-import org.hibernate.internal.util.MutableInteger;
 import org.hibernate.query.spi.Limit;
 import org.hibernate.query.spi.QueryOptions;
 import org.hibernate.resource.jdbc.spi.JdbcSessionContext;
@@ -94,12 +93,10 @@ public DeferredResultSetAccess(
 			}
 			else {
 				limitHandler = dialect.getLimitHandler();
-				final MutableInteger parameterMarkerPosition = new MutableInteger( jdbcParameterBindings.getBindings().size() );
 				sql = limitHandler.processSql(
 						jdbcSelect.getSqlString(),
 						limit,
-						queryOptions,
-						() -> parameterMarkerStrategy.createMarker( parameterMarkerPosition.incrementAndGet(), null )
+						queryOptions
 				);
 			}
 
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
@@ -703,6 +703,7 @@ public boolean apply(Dialect dialect) {
 	public static class SupportsNativeParameterMarker implements DialectFeatureCheck {
 		@Override
 		public boolean apply(Dialect dialect) {
+			dialect = DialectDelegateWrapper.extractRealDialect( dialect );
 			return dialect.getNativeParameterMarkerStrategy() != null;
 		}
 	}

Original file line number	Diff line number	Diff line change
`@@ -33,6 +33,10 @@ public static SqmJdbcExecutionContextAdapter usingLockingAndPaging(DomainQueryEx`
`33`	`33`	`return new SqmJdbcExecutionContextAdapter( sqmExecutionContext, sqmExecutionContext.getQueryOptions() );`
`34`	`34`	`}`
`35`	`35`
	`36`	`+ public static SqmJdbcExecutionContextAdapter usingLockingAndPaging(DomainQueryExecutionContext sqmExecutionContext, QueryOptions queryOptions) {`
	`37`	`+ return new SqmJdbcExecutionContextAdapter( sqmExecutionContext, queryOptions );`
	`38`	`+ }`
	`39`	`+`
`36`	`40`	`private final DomainQueryExecutionContext sqmExecutionContext;`
`37`	`41`	`private final QueryOptions queryOptions;`
`38`	`42`
Original file line number	Diff line number	Diff line change
`@@ -703,6 +703,7 @@ public boolean apply(Dialect dialect) {`
`703`	`703`	`public static class SupportsNativeParameterMarker implements DialectFeatureCheck {`
`704`	`704`	`@Override`
`705`	`705`	`public boolean apply(Dialect dialect) {`
	`706`	`+ dialect = DialectDelegateWrapper.extractRealDialect( dialect );`
`706`	`707`	`return dialect.getNativeParameterMarkerStrategy() != null;`
`707`	`708`	`}`
`708`	`709`	`}`