HHH-19632 Give access to optional parameter info in SqlAstTranslator

beikov · beikov · commit 5801c25d94ab · 2025-07-28T21:06:10.000+02:00
diff --git a/hibernate-core/src/main/java/org/hibernate/query/sqm/internal/ConcreteSqmSelectQueryPlan.java b/hibernate-core/src/main/java/org/hibernate/query/sqm/internal/ConcreteSqmSelectQueryPlan.java
@@ -493,7 +493,7 @@ private static CacheableSqmInterpretation buildCacheableSqmInterpretation(
 
 		final SqlAstTranslator<JdbcOperationQuerySelect> selectTranslator =
 				sessionFactory.getJdbcServices().getJdbcEnvironment().getSqlAstTranslatorFactory()
-						.buildSelectTranslator( sessionFactory, sqmInterpretation.getSqlAst() );
+						.buildSelectTranslator( sessionFactory, sqmInterpretation.getSqlAst(), sqmInterpretation.getParameterInfo() );
 
 		final var jdbcParamsXref =
 				generateJdbcParamsXref( domainParameterXref, sqmInterpretation::getJdbcParamsBySqmParam );
diff --git a/hibernate-core/src/main/java/org/hibernate/query/sqm/mutation/internal/MatchingIdSelectionHelper.java b/hibernate-core/src/main/java/org/hibernate/query/sqm/mutation/internal/MatchingIdSelectionHelper.java
@@ -274,7 +274,7 @@ public static List<Object> selectMatchingIds(
 		final JdbcEnvironment jdbcEnvironment = jdbcServices.getJdbcEnvironment();
 		final SqlAstTranslator<JdbcOperationQuerySelect> sqlAstSelectTranslator = jdbcEnvironment
 				.getSqlAstTranslatorFactory()
-				.buildSelectTranslator( factory, translation.getSqlAst() );
+				.buildSelectTranslator( factory, translation.getSqlAst(), translation.getParameterInfo() );
 
 		final JdbcParameterBindings jdbcParameterBindings = SqmUtil.createJdbcParameterBindings(
 				executionContext.getQueryParameterBindings(),
diff --git a/hibernate-core/src/main/java/org/hibernate/query/sqm/sql/SqmTranslation.java b/hibernate-core/src/main/java/org/hibernate/query/sqm/sql/SqmTranslation.java
@@ -9,6 +9,7 @@
 
 import org.hibernate.metamodel.mapping.MappingModelExpressible;
 import org.hibernate.query.sqm.tree.expression.SqmParameter;
+import org.hibernate.sql.ast.SqlParameterInfo;
 import org.hibernate.sql.ast.spi.FromClauseAccess;
 import org.hibernate.sql.ast.spi.SqlExpressionResolver;
 import org.hibernate.sql.ast.tree.Statement;
@@ -25,4 +26,11 @@ public interface SqmTranslation<T extends Statement> {
 	FromClauseAccess getFromClauseAccess();
 	Map<SqmParameter<?>, List<List<JdbcParameter>>> getJdbcParamsBySqmParam();
 	Map<SqmParameter<?>, MappingModelExpressible<?>> getSqmParameterMappingModelTypeResolutions();
+
+	/**
+	 * The parameter information for the SQL AST.
+	 *
+	 * @since 7.1
+	 */
+	SqlParameterInfo getParameterInfo();
 }
diff --git a/hibernate-core/src/main/java/org/hibernate/query/sqm/sql/StandardSqmTranslation.java b/hibernate-core/src/main/java/org/hibernate/query/sqm/sql/StandardSqmTranslation.java
@@ -4,11 +4,15 @@
  */
 package org.hibernate.query.sqm.sql;
 
+import java.util.Collections;
+import java.util.IdentityHashMap;
 import java.util.List;
 import java.util.Map;
 
 import org.hibernate.metamodel.mapping.MappingModelExpressible;
 import org.hibernate.query.sqm.tree.expression.SqmParameter;
+import org.hibernate.sql.ast.SqlParameterInfo;
+import org.hibernate.sql.ast.internal.SqlParameterInfoImpl;
 import org.hibernate.sql.ast.spi.FromClauseAccess;
 import org.hibernate.sql.ast.spi.SqlExpressionResolver;
 import org.hibernate.sql.ast.tree.Statement;
@@ -24,6 +28,7 @@ public class StandardSqmTranslation<T extends Statement> implements SqmTranslati
 	private final Map<SqmParameter<?>, MappingModelExpressible<?>> parameterMappingModelTypeMap;
 	private final SqlExpressionResolver sqlExpressionResolver;
 	private final FromClauseAccess fromClauseAccess;
+	private final SqlParameterInfo parameterInfo;
 
 	public StandardSqmTranslation(
 			T sqlAst,
@@ -36,6 +41,19 @@ public StandardSqmTranslation(
 		this.parameterMappingModelTypeMap = parameterMappingModelTypeMap;
 		this.sqlExpressionResolver = sqlExpressionResolver;
 		this.fromClauseAccess = fromClauseAccess;
+		final IdentityHashMap<JdbcParameter, Integer> parameterIdMap = new IdentityHashMap<>();
+		int parameterId = 0;
+		for ( Map.Entry<SqmParameter<?>, List<List<JdbcParameter>>> entry : jdbcParamMap.entrySet() ) {
+			final List<List<JdbcParameter>> parameterUses = entry.getValue();
+			final int baseId = parameterId;
+			for ( List<JdbcParameter> jdbcParameters : parameterUses ) {
+				for ( int i = 0; i < jdbcParameters.size(); i++ ) {
+					parameterIdMap.put( jdbcParameters.get( i ), baseId + i );
+				}
+			}
+			parameterId += parameterUses.get( 0 ).size();
+		}
+		this.parameterInfo = new SqlParameterInfoImpl( Collections.unmodifiableMap( parameterIdMap ) );
 	}
 
 	@Override
@@ -62,4 +80,9 @@ public SqlExpressionResolver getSqlExpressionResolver() {
 	public FromClauseAccess getFromClauseAccess() {
 		return fromClauseAccess;
 	}
+
+	@Override
+	public SqlParameterInfo getParameterInfo() {
+		return parameterInfo;
+	}
 }
diff --git a/hibernate-core/src/main/java/org/hibernate/sql/ast/SqlAstTranslatorFactory.java b/hibernate-core/src/main/java/org/hibernate/sql/ast/SqlAstTranslatorFactory.java
@@ -23,6 +23,13 @@ public interface SqlAstTranslatorFactory {
 	 */
 	SqlAstTranslator<JdbcOperationQuerySelect> buildSelectTranslator(SessionFactoryImplementor sessionFactory, SelectStatement statement);
 
+	/**
+	 * Builds a single-use select translator
+	 *
+	 * @since 7.1
+	 */
+	SqlAstTranslator<JdbcOperationQuerySelect> buildSelectTranslator(SessionFactoryImplementor sessionFactory, SelectStatement statement, SqlParameterInfo parameterInfo);
+
 	/**
 	 * Builds a single-use mutation translator
 	 */
diff --git a/hibernate-core/src/main/java/org/hibernate/sql/ast/SqlParameterInfo.java b/hibernate-core/src/main/java/org/hibernate/sql/ast/SqlParameterInfo.java
@@ -0,0 +1,19 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ * Copyright Red Hat Inc. and Hibernate Authors
+ */
+package org.hibernate.sql.ast;
+
+import org.hibernate.sql.ast.tree.expression.JdbcParameter;
+
+/**
+ * Parameter information for {@link JdbcParameter} within a SQL query.
+ *
+ * @since 7.1
+ */
+public interface SqlParameterInfo {
+	/**
+	 * Returns the parameter id or bind position for the given {@link JdbcParameter}.
+	 */
+	int getParameterId(JdbcParameter jdbcParameter);
+}
diff --git a/hibernate-core/src/main/java/org/hibernate/sql/ast/internal/SqlParameterInfoImpl.java b/hibernate-core/src/main/java/org/hibernate/sql/ast/internal/SqlParameterInfoImpl.java
@@ -0,0 +1,38 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ * Copyright Red Hat Inc. and Hibernate Authors
+ */
+package org.hibernate.sql.ast.internal;
+
+import org.hibernate.sql.ast.SqlParameterInfo;
+import org.hibernate.sql.ast.tree.expression.JdbcParameter;
+
+import java.util.IdentityHashMap;
+import java.util.Map;
+
+/**
+ * @since 7.0
+ */
+public class SqlParameterInfoImpl implements SqlParameterInfo {
+
+	private final Map<JdbcParameter, Integer> parameterIdMap;
+
+	public SqlParameterInfoImpl() {
+		this(new IdentityHashMap<>());
+	}
+
+	public SqlParameterInfoImpl(Map<JdbcParameter, Integer> parameterIdMap) {
+		this.parameterIdMap = parameterIdMap;
+	}
+
+	@Override
+	public int getParameterId(JdbcParameter jdbcParameter) {
+		final Integer id = parameterIdMap.get( jdbcParameter );
+		if ( id == null ) {
+			final int newId = parameterIdMap.size();
+			parameterIdMap.put( jdbcParameter, newId );
+			return newId;
+		}
+		return id;
+	}
+}
diff --git a/hibernate-core/src/main/java/org/hibernate/sql/ast/spi/AbstractSqlAstTranslator.java b/hibernate-core/src/main/java/org/hibernate/sql/ast/spi/AbstractSqlAstTranslator.java
@@ -4,6 +4,7 @@
  */
 package org.hibernate.sql.ast.spi;
 
+import org.checkerframework.checker.nullness.qual.Nullable;
 import jakarta.persistence.criteria.Nulls;
 import org.hibernate.AssertionFailure;
 import org.hibernate.Internal;
@@ -69,9 +70,11 @@
 import org.hibernate.sql.ast.SqlAstJoinType;
 import org.hibernate.sql.ast.SqlAstNodeRenderingMode;
 import org.hibernate.sql.ast.SqlAstTranslator;
+import org.hibernate.sql.ast.SqlParameterInfo;
 import org.hibernate.sql.ast.SqlTreeCreationException;
-import org.hibernate.sql.ast.internal.ParameterMarkerStrategyStandard;
+import org.hibernate.sql.ast.internal.SqlParameterInfoImpl;
 import org.hibernate.sql.ast.internal.TableGroupHelper;
+import org.hibernate.sql.ast.internal.ParameterMarkerStrategyStandard;
 import org.hibernate.sql.ast.tree.AbstractUpdateOrDeleteStatement;
 import org.hibernate.sql.ast.tree.MutationStatement;
 import org.hibernate.sql.ast.tree.SqlAstNode;
@@ -269,6 +272,7 @@ public abstract class AbstractSqlAstTranslator<T extends JdbcOperation> implemen
 	private final Stack<Clause> clauseStack = new StandardStack<>();
 	private final Stack<QueryPart> queryPartStack = new StandardStack<>();
 	private final Stack<Statement> statementStack = new StandardStack<>();
+	private @Nullable SqlParameterInfo parameterInfo;
 
 	/**
 	 * Used to identify the QuerySpec to which locking (for update, e.g.) should
@@ -308,11 +312,16 @@ public abstract class AbstractSqlAstTranslator<T extends JdbcOperation> implemen
 	private JdbcParameter limitParameter;
 
 	protected AbstractSqlAstTranslator(SessionFactoryImplementor sessionFactory, Statement statement) {
+		this( sessionFactory, statement, null );
+	}
+
+	protected AbstractSqlAstTranslator(SessionFactoryImplementor sessionFactory, Statement statement, @Nullable SqlParameterInfo parameterInfo) {
 		this.sessionFactory = sessionFactory;
 		final JdbcServices jdbcServices = sessionFactory.getJdbcServices();
 		this.dialect = jdbcServices.getDialect();
 		this.statementStack.push( statement );
 		this.parameterMarkerStrategy = jdbcServices.getParameterMarkerStrategy();
+		this.parameterInfo = parameterInfo;
 
 		if ( statement instanceof SelectStatement selectStatement ) {
 			// ideally we'd only do this if there are LockOptions,
@@ -346,6 +355,13 @@ public SessionFactoryImplementor getSessionFactory() {
 		return sessionFactory;
 	}
 
+	protected SqlParameterInfo getParameterInfo() {
+		if ( parameterInfo == null ) {
+			parameterInfo = new SqlParameterInfoImpl();
+		}
+		return parameterInfo;
+	}
+
 	protected FunctionRenderer castFunction() {
 		if ( castFunction == null ) {
 			castFunction = findSelfRenderingFunction( "cast", 2 );
diff --git a/hibernate-core/src/main/java/org/hibernate/sql/ast/spi/StandardSqlAstTranslator.java b/hibernate-core/src/main/java/org/hibernate/sql/ast/spi/StandardSqlAstTranslator.java
@@ -4,7 +4,9 @@
  */
 package org.hibernate.sql.ast.spi;
 
+import org.checkerframework.checker.nullness.qual.Nullable;
 import org.hibernate.engine.spi.SessionFactoryImplementor;
+import org.hibernate.sql.ast.SqlParameterInfo;
 import org.hibernate.sql.ast.tree.Statement;
 import org.hibernate.sql.exec.spi.JdbcOperation;
 import org.hibernate.sql.exec.spi.JdbcOperationQuerySelect;
@@ -21,4 +23,8 @@ public class StandardSqlAstTranslator<T extends JdbcOperation> extends AbstractS
 	public StandardSqlAstTranslator(SessionFactoryImplementor sessionFactory, Statement statement) {
 		super( sessionFactory, statement );
 	}
+
+	public StandardSqlAstTranslator(SessionFactoryImplementor sessionFactory, Statement statement, @Nullable SqlParameterInfo parameterInfo) {
+		super( sessionFactory, statement, parameterInfo );
+	}
 }
diff --git a/hibernate-core/src/main/java/org/hibernate/sql/ast/spi/StandardSqlAstTranslatorFactory.java b/hibernate-core/src/main/java/org/hibernate/sql/ast/spi/StandardSqlAstTranslatorFactory.java
@@ -4,9 +4,11 @@
  */
 package org.hibernate.sql.ast.spi;
 
+import org.checkerframework.checker.nullness.qual.Nullable;
 import org.hibernate.engine.spi.SessionFactoryImplementor;
 import org.hibernate.sql.ast.SqlAstTranslator;
 import org.hibernate.sql.ast.SqlAstTranslatorFactory;
+import org.hibernate.sql.ast.SqlParameterInfo;
 import org.hibernate.sql.ast.tree.MutationStatement;
 import org.hibernate.sql.ast.tree.Statement;
 import org.hibernate.sql.ast.tree.select.SelectStatement;
@@ -22,20 +24,24 @@
  * @author Steve Ebersole
  */
 public class StandardSqlAstTranslatorFactory implements SqlAstTranslatorFactory {
-
 	@Override
 	public SqlAstTranslator<JdbcOperationQuerySelect> buildSelectTranslator(SessionFactoryImplementor sessionFactory, SelectStatement statement) {
-		return buildTranslator( sessionFactory, statement );
+		return buildTranslator( sessionFactory, statement, null );
+	}
+
+	@Override
+	public SqlAstTranslator<JdbcOperationQuerySelect> buildSelectTranslator(SessionFactoryImplementor sessionFactory, SelectStatement statement, SqlParameterInfo parameterInfo) {
+		return buildTranslator( sessionFactory, statement, parameterInfo );
 	}
 
 	@Override
 	public SqlAstTranslator<? extends JdbcOperationQueryMutation> buildMutationTranslator(SessionFactoryImplementor sessionFactory, MutationStatement statement) {
-		return buildTranslator( sessionFactory, statement );
+		return buildTranslator( sessionFactory, statement, null );
 	}
 
 	@Override
 	public <O extends JdbcMutationOperation> SqlAstTranslator<O> buildModelMutationTranslator(TableMutation<O> mutation, SessionFactoryImplementor sessionFactory) {
-		return buildTranslator( sessionFactory, mutation );
+		return buildTranslator( sessionFactory, mutation, null );
 	}
 
 	/**
@@ -45,4 +51,11 @@ protected <T extends JdbcOperation> SqlAstTranslator<T> buildTranslator(SessionF
 		return new StandardSqlAstTranslator<>( sessionFactory, statement );
 	}
 
+	/**
+	 * Consolidated building of a translator for all Query cases
+	 */
+	protected <T extends JdbcOperation> SqlAstTranslator<T> buildTranslator(SessionFactoryImplementor sessionFactory, Statement statement, @Nullable SqlParameterInfo parameterInfo) {
+		return buildTranslator( sessionFactory, statement );
+	}
+
 }
