HHH-19364 add support for QuerySpecification with criteria queries

gavinking · gavinking · commit 7c79f1aaf37b · 2025-04-17T23:28:41.000+02:00
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
@@ -667,11 +667,26 @@ public <T> SelectionSpecification<T> createSelectionSpecification(Class<T> rootE
 		return delegate.createSelectionSpecification( rootEntityType );
 	}
 
+	@Override
+	public <T> SelectionSpecification<T> createSelectionSpecification(CriteriaQuery<T> criteria) {
+		return delegate.createSelectionSpecification( criteria );
+	}
+
 	@Override
 	public <T> MutationSpecification<T> createMutationSpecification(String hql, Class<T> mutationTarget) {
 		return delegate.createMutationSpecification( hql, mutationTarget );
 	}
 
+	@Override
+	public <T> MutationSpecification<T> createMutationSpecification(CriteriaUpdate<T> criteriaUpdate) {
+		return delegate.createMutationSpecification( criteriaUpdate );
+	}
+
+	@Override
+	public <T> MutationSpecification<T> createMutationSpecification(CriteriaDelete<T> criteriaDelete) {
+		return delegate.createMutationSpecification( criteriaDelete );
+	}
+
 	@Override
 	public MutationQuery createNativeMutationQuery(String sqlString) {
 		return delegate.createNativeMutationQuery( sqlString );
diff --git a/hibernate-core/src/main/java/org/hibernate/engine/spi/SessionLazyDelegator.java b/hibernate-core/src/main/java/org/hibernate/engine/spi/SessionLazyDelegator.java
@@ -760,11 +760,26 @@ public <T> SelectionSpecification<T> createSelectionSpecification(Class<T> rootE
 		return this.lazySession.get().createSelectionSpecification( rootEntityType );
 	}
 
+	@Override
+	public <T> SelectionSpecification<T> createSelectionSpecification(CriteriaQuery<T> criteria) {
+		return this.lazySession.get().createSelectionSpecification( criteria );
+	}
+
 	@Override
 	public <T> MutationSpecification<T> createMutationSpecification(String hql, Class<T> mutationTarget) {
 		return this.lazySession.get().createMutationSpecification( hql, mutationTarget );
 	}
 
+	@Override
+	public <T> MutationSpecification<T> createMutationSpecification(CriteriaUpdate<T> criteriaUpdate) {
+		return this.lazySession.get().createMutationSpecification( criteriaUpdate );
+	}
+
+	@Override
+	public <T> MutationSpecification<T> createMutationSpecification(CriteriaDelete<T> criteriaDelete) {
+		return this.lazySession.get().createMutationSpecification( criteriaDelete );
+	}
+
 	@SuppressWarnings("rawtypes")
 	@Override
 	@Deprecated
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
@@ -239,11 +239,26 @@ public <T> SelectionSpecification<T> createSelectionSpecification(Class<T> rootE
 		return delegate.createSelectionSpecification( rootEntityType );
 	}
 
+	@Override
+	public <T> SelectionSpecification<T> createSelectionSpecification(CriteriaQuery<T> criteria) {
+		return delegate.createSelectionSpecification( criteria );
+	}
+
 	@Override
 	public <T> MutationSpecification<T> createMutationSpecification(String hql, Class<T> mutationTarget) {
 		return delegate.createMutationSpecification( hql, mutationTarget );
 	}
 
+	@Override
+	public <T> MutationSpecification<T> createMutationSpecification(CriteriaUpdate<T> criteriaUpdate) {
+		return delegate.createMutationSpecification( criteriaUpdate );
+	}
+
+	@Override
+	public <T> MutationSpecification<T> createMutationSpecification(CriteriaDelete<T> criteriaDelete) {
+		return delegate.createMutationSpecification( criteriaDelete );
+	}
+
 	@Override
 	public MutationQuery createNativeMutationQuery(String sqlString) {
 		return delegate.createNativeMutationQuery( sqlString );
diff --git a/hibernate-core/src/main/java/org/hibernate/internal/AbstractSharedSessionContract.java b/hibernate-core/src/main/java/org/hibernate/internal/AbstractSharedSessionContract.java
@@ -1270,11 +1270,26 @@ public <T> SelectionSpecification<T> createSelectionSpecification(Class<T> rootE
 		return new SelectionSpecificationImpl<>( rootEntityType, this );
 	}
 
+	@Override
+	public <T> SelectionSpecification<T> createSelectionSpecification(CriteriaQuery<T> criteria) {
+		return new SelectionSpecificationImpl<>( criteria, this );
+	}
+
 	@Override
 	public <T> MutationSpecification<T> createMutationSpecification(String hql, Class<T> mutationTarget) {
 		return new MutationSpecificationImpl<>( hql, mutationTarget, this );
 	}
 
+	@Override
+	public <T> MutationSpecification<T> createMutationSpecification(CriteriaDelete<T> criteriaDelete) {
+		return new MutationSpecificationImpl<>( criteriaDelete, this );
+	}
+
+	@Override
+	public <T> MutationSpecification<T> createMutationSpecification(CriteriaUpdate<T> criteriaUpdate)  {
+		return new MutationSpecificationImpl<>( criteriaUpdate, this );
+	}
+
 	protected <T> NativeQueryImplementor<T> createNativeQueryImplementor(String queryName, NamedNativeQueryMemento<T> memento) {
 		final NativeQueryImplementor<T> query = memento.toQuery( this );
 		final Boolean isUnequivocallySelect = query.isSelectQuery();
diff --git a/hibernate-core/src/main/java/org/hibernate/query/QueryProducer.java b/hibernate-core/src/main/java/org/hibernate/query/QueryProducer.java
@@ -538,6 +538,21 @@ <T> SelectionSpecification<T> createSelectionSpecification(String hql, Class<T>
 	@Incubating
 	<T> SelectionSpecification<T> createSelectionSpecification(Class<T> rootEntityType);
 
+	/**
+	 * Returns a specification reference which can be used to programmatically,
+	 * iteratively build a {@linkplain SelectionQuery} for the given criteria query,
+	 * allowing the addition of {@linkplain SelectionSpecification#addOrdering sorting}
+	 * and {@linkplain SelectionSpecification#addRestriction restrictions}.
+	 *
+	 * @param criteria The criteria query
+	 *
+	 * @param <T> The entity type which is the root of the query.
+	 *
+	 * @since 7.0
+	 */
+	@Incubating
+	<T> SelectionSpecification<T> createSelectionSpecification(CriteriaQuery<T> criteria);
+
 	/**
 	 * Returns a specification reference which can be used to programmatically,
 	 * iteratively build a {@linkplain MutationQuery} based on a base HQL statement,
@@ -558,6 +573,34 @@ <T> SelectionSpecification<T> createSelectionSpecification(String hql, Class<T>
 	<T> MutationSpecification<T> createMutationSpecification(String hql, Class<T> mutationTarget)
 			throws IllegalMutationQueryException;
 
+	/**
+	 * Returns a specification reference which can be used to programmatically,
+	 * iteratively build a {@linkplain MutationQuery} based on the given criteria update,
+	 * allowing the addition of {@linkplain MutationSpecification#addRestriction restrictions}.
+	 *
+	 * @param criteriaUpdate The criteria update query
+	 *
+	 * @param <T> The root entity type for the mutation (the "target").
+	 *
+	 * @since 7.0
+	 */
+	@Incubating
+	<T> MutationSpecification<T> createMutationSpecification(CriteriaUpdate<T> criteriaUpdate);
+
+	/**
+	 * Returns a specification reference which can be used to programmatically,
+	 * iteratively build a {@linkplain MutationQuery} based on the given criteria delete,
+	 * allowing the addition of {@linkplain MutationSpecification#addRestriction restrictions}.
+	 *
+	 * @param criteriaDelete The criteria delete query
+	 *
+	 * @param <T> The root entity type for the mutation (the "target").
+	 *
+	 * @since 7.0
+	 */
+	@Incubating
+	<T> MutationSpecification<T> createMutationSpecification(CriteriaDelete<T> criteriaDelete);
+
 	/**
 	 * Create a {@link Query} instance for the named query.
 	 *
diff --git a/hibernate-core/src/main/java/org/hibernate/query/programmatic/internal/MutationSpecificationImpl.java b/hibernate-core/src/main/java/org/hibernate/query/programmatic/internal/MutationSpecificationImpl.java
@@ -5,6 +5,8 @@
 package org.hibernate.query.programmatic.internal;
 
 import jakarta.persistence.criteria.CommonAbstractCriteria;
+import jakarta.persistence.criteria.CriteriaDelete;
+import jakarta.persistence.criteria.CriteriaUpdate;
 import jakarta.persistence.criteria.Root;
 import org.hibernate.engine.spi.SharedSessionContractImplementor;
 import org.hibernate.query.programmatic.MutationSpecification;
@@ -17,8 +19,10 @@
 import org.hibernate.query.sqm.internal.QuerySqmImpl;
 import org.hibernate.query.sqm.internal.SqmUtil;
 import org.hibernate.query.sqm.tree.SqmDeleteOrUpdateStatement;
+import org.hibernate.query.sqm.tree.delete.SqmDeleteStatement;
 import org.hibernate.query.sqm.tree.from.SqmRoot;
 import org.hibernate.query.sqm.tree.predicate.SqmPredicate;
+import org.hibernate.query.sqm.tree.update.SqmUpdateStatement;
 
 import java.util.Locale;
 
@@ -44,6 +48,22 @@ public MutationSpecificationImpl(
 		this.mutationTargetRoot = resolveSqmRoot( this.sqmStatement, mutationTarget );
 	}
 
+	public MutationSpecificationImpl(
+			CriteriaUpdate<T> criteriaQuery,
+			SharedSessionContractImplementor session) {
+		this.session = session;
+		this.sqmStatement = (SqmUpdateStatement<T>) criteriaQuery;
+		this.mutationTargetRoot = resolveSqmRoot( sqmStatement, sqmStatement.getTarget().getManagedType().getJavaType() );
+	}
+
+	public MutationSpecificationImpl(
+			CriteriaDelete<T> criteriaQuery,
+			SharedSessionContractImplementor session) {
+		this.session = session;
+		this.sqmStatement = (SqmDeleteStatement<T>) criteriaQuery;
+		this.mutationTargetRoot = resolveSqmRoot( sqmStatement, sqmStatement.getTarget().getManagedType().getJavaType() );
+	}
+
 	@Override
 	public Root<T> getRoot() {
 		return mutationTargetRoot;
diff --git a/hibernate-core/src/main/java/org/hibernate/query/programmatic/internal/SelectionSpecificationImpl.java b/hibernate-core/src/main/java/org/hibernate/query/programmatic/internal/SelectionSpecificationImpl.java
@@ -60,6 +60,15 @@ public SelectionSpecificationImpl(
 		this( "from " + determineEntityName( rootEntityType, session ), rootEntityType, session );
 	}
 
+	public SelectionSpecificationImpl(
+			CriteriaQuery<T> criteriaQuery,
+			SharedSessionContractImplementor session) {
+		this.resultType = criteriaQuery.getResultType();
+		this.session = session;
+		this.sqmStatement = (SqmSelectStatement<T>) criteriaQuery;
+		this.sqmRoot = extractRoot( sqmStatement, resultType, "criteria query" );
+	}
+
 	@Override
 	public Root<T> getRoot() {
 		return sqmRoot;
diff --git a/hibernate-core/src/test/java/org/hibernate/orm/test/query/dynamic/SimpleQuerySpecificationTests.java b/hibernate-core/src/test/java/org/hibernate/orm/test/query/dynamic/SimpleQuerySpecificationTests.java
@@ -168,6 +168,27 @@ void testRootEntityForm(SessionFactoryScope factoryScope) {
 		assertThat( sqlCollector.getSqlQueries().get( 0 ) ).contains( " order by be1_0.position" );
 	}
 
+	@Test
+	void testCriteriaForm(SessionFactoryScope factoryScope) {
+		final SQLStatementInspector sqlCollector = factoryScope.getCollectingStatementInspector();
+
+		factoryScope.inTransaction( (session) -> {
+			sqlCollector.clear();
+			var criteriaBuilder = session.getCriteriaBuilder();
+			var query = criteriaBuilder.createQuery( BasicEntity.class );
+			var entity = query.from( BasicEntity.class );
+			query.select( entity );
+			query.where( criteriaBuilder.like( entity.get( BasicEntity_.name ), "%" ) );
+			session.createSelectionSpecification( query )
+					.addOrdering( Order.asc( BasicEntity_.position ) )
+					.createQuery()
+					.getResultList();
+		} );
+
+		assertThat( sqlCollector.getSqlQueries() ).hasSize( 1 );
+		assertThat( sqlCollector.getSqlQueries().get( 0 ) ).contains( " order by be1_0.position" );
+	}
+
 	@Test
 	void testBaseParameters(SessionFactoryScope factoryScope) {
 		final SQLStatementInspector sqlCollector = factoryScope.getCollectingStatementInspector();
