HHH-19493 add HCB.id(), HCB.version(), and JpaFrom.id()

gavinking · gavinking · commit 7bae44e9b3a1 · 2025-05-29T09:29:45.000+02:00
diff --git a/hibernate-core/src/main/java/org/hibernate/metamodel/mapping/EntityVersionMapping.java b/hibernate-core/src/main/java/org/hibernate/metamodel/mapping/EntityVersionMapping.java
@@ -17,6 +17,10 @@ public interface EntityVersionMapping extends BasicValuedModelPart {
 
 	String VERSION_ROLE_NAME = "{version}";
 
+	static boolean matchesRoleName(String name) {
+		return VERSION_ROLE_NAME.equals( name );
+	}
+
 	/**
 	 * The attribute marked as the version
 	 */
diff --git a/hibernate-core/src/main/java/org/hibernate/metamodel/model/domain/internal/AbstractIdentifiableType.java b/hibernate-core/src/main/java/org/hibernate/metamodel/model/domain/internal/AbstractIdentifiableType.java
@@ -261,7 +261,7 @@ public <Y> SingularPersistentAttribute<? super J, Y> getVersion(Class<Y> javaTyp
 	}
 
 	@Override
-	public SingularPersistentAttribute<? super J, ?> findVersionAttribute() {
+	public SqmSingularPersistentAttribute<? super J, ?> findVersionAttribute() {
 		if ( versionAttribute != null ) {
 			return versionAttribute;
 		}
diff --git a/hibernate-core/src/main/java/org/hibernate/metamodel/model/domain/internal/EntityTypeImpl.java b/hibernate-core/src/main/java/org/hibernate/metamodel/model/domain/internal/EntityTypeImpl.java
@@ -17,6 +17,7 @@
 import org.hibernate.metamodel.mapping.DiscriminatorType;
 import org.hibernate.metamodel.mapping.EntityDiscriminatorMapping;
 import org.hibernate.metamodel.mapping.EntityIdentifierMapping;
+import org.hibernate.metamodel.mapping.EntityVersionMapping;
 import org.hibernate.metamodel.model.domain.IdentifiableDomainType;
 import org.hibernate.metamodel.model.domain.JpaMetamodel;
 import org.hibernate.metamodel.model.domain.PersistentAttribute;
@@ -27,7 +28,6 @@
 import org.hibernate.query.sqm.tree.domain.SqmManagedDomainType;
 import org.hibernate.query.sqm.tree.domain.SqmPath;
 import org.hibernate.query.sqm.tree.domain.SqmPersistentAttribute;
-import org.hibernate.query.sqm.tree.domain.SqmSingularPersistentAttribute;
 import org.hibernate.query.sqm.tree.domain.SqmEntityDomainType;
 import org.hibernate.type.descriptor.java.JavaType;
 
@@ -156,6 +156,9 @@ public SqmPathSource<?> findSubPathSource(String name) {
 		else if ( EntityIdentifierMapping.matchesRoleName( name ) ) {
 			return hasSingleIdAttribute() ? findIdAttribute() : getIdentifierDescriptor();
 		}
+		else if ( EntityVersionMapping.matchesRoleName( name ) ) {
+			return hasVersionAttribute() ? findVersionAttribute() : null;
+		}
 		else if ( EntityDiscriminatorMapping.matchesRoleName( name ) ) {
 			return discriminatorPathSource;
 		}
@@ -164,11 +167,6 @@ else if ( EntityDiscriminatorMapping.matchesRoleName( name ) ) {
 		}
 	}
 
-	@Override
-	public SqmSingularPersistentAttribute<? super J, ?> findIdAttribute() {
-		return super.findIdAttribute();
-	}
-
 	@Override
 	public SqmPathSource<?> getIdentifierDescriptor() {
 		return super.getIdentifierDescriptor();
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
@@ -352,7 +352,11 @@ default <T> JpaSubQuery<T> except(Subquery<? extends T> query1, Subquery<?>... q
 	// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 	// Paths
 
-	<P, F> JpaExpression<F> fk(Path<P> path);
+	JpaExpression<?> id(Path<?> path);
+
+	JpaExpression<?> version(Path<?> path);
+
+	JpaExpression<?> fk(Path<?> path);
 
 	@Override
 	<X, T extends X> JpaPath<T> treat(Path<X> path, Class<T> type);
diff --git a/hibernate-core/src/main/java/org/hibernate/query/criteria/JpaFrom.java b/hibernate-core/src/main/java/org/hibernate/query/criteria/JpaFrom.java
@@ -324,4 +324,7 @@ default <X> JpaJoin<?, X> join(JpaCteCriteria<X> cte, org.hibernate.query.common
 
 	@Override
 	<S extends T> JpaTreatedFrom<O,T,S> treatAs(EntityDomainType<S> treatJavaType);
+
+	@Incubating
+	JpaExpression<?> id();
 }
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
@@ -335,7 +335,7 @@ public <N, T extends Temporal> JpaExpression<N> extract(TemporalField<N, T> fiel
 	}
 
 	@Override
-	public <P, F> JpaExpression<F> fk(Path<P> path) {
+	public JpaExpression<?> fk(Path<?> path) {
 		return criteriaBuilder.fk( path );
 	}
 
@@ -799,6 +799,16 @@ public JpaFunction<Instant> currentInstant() {
 		return criteriaBuilder.currentInstant();
 	}
 
+	@Override
+	public JpaExpression<?> id(Path<?> path) {
+		return criteriaBuilder.id( path );
+	}
+
+	@Override
+	public JpaExpression<?> version(Path<?> path) {
+		return criteriaBuilder.version( path );
+	}
+
 	@Override
 	public <T> JpaFunction<T> function(String name, Class<T> type, Expression<?>... args) {
 		return criteriaBuilder.function( name, type, args );
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
@@ -3472,7 +3472,8 @@ public SqmPath<?> visitEntityIdReference(HqlParser.EntityIdReferenceContext ctx)
 			return sqmPath.get( identifierDescriptor.getPathName(), true );
 		}
 		else if ( sqmPath instanceof SqmAnyValuedSimplePath<?> ) {
-			return sqmPath.resolvePathPart( AnyKeyPart.KEY_NAME, true, processingStateStack.getCurrent().getCreationState() );
+			return sqmPath.resolvePathPart( AnyKeyPart.KEY_NAME, true,
+					processingStateStack.getCurrent().getCreationState() );
 		}
 		else {
 			throw new FunctionArgumentException( "Argument '" + sqmPath.getNavigablePath()
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
@@ -976,7 +976,13 @@ <T> SqmJsonValueExpression<T> jsonValue(
 	SqmPredicate wrap(Expression<Boolean>... expressions);
 
 	@Override
-	<P, F> SqmExpression<F> fk(Path<P> path);
+	SqmExpression<?> fk(Path<?> path);
+
+	@Override
+	SqmExpression<?> id(Path<?> path);
+
+	@Override
+	SqmExpression<?> version(Path<?> path);
 
 	@Override
 	<X, T extends X> SqmPath<T> treat(Path<X> path, Class<T> type);
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
@@ -43,6 +43,8 @@
 import org.hibernate.internal.util.ReflectHelper;
 import org.hibernate.internal.util.StringHelper;
 import org.hibernate.jpa.spi.JpaCompliance;
+import org.hibernate.metamodel.mapping.EntityIdentifierMapping;
+import org.hibernate.metamodel.mapping.EntityVersionMapping;
 import org.hibernate.metamodel.model.domain.DomainType;
 import org.hibernate.metamodel.model.domain.JpaMetamodel;
 import org.hibernate.metamodel.model.domain.PersistentAttribute;
@@ -602,8 +604,8 @@ public <T extends HibernateCriteriaBuilder> T unwrap(Class<T> clazz) {
 	}
 
 	@Override
-	public <P, F> SqmExpression<F> fk(Path<P> path) {
-		final SqmPath<P> sqmPath = (SqmPath<P>) path;
+	public SqmPath<?> fk(Path<?> path) {
+		final SqmPath<?> sqmPath = (SqmPath<?>) path;
 		final SqmPathSource<?> toOneReference = sqmPath.getReferencedPathSource();
 		final boolean validToOneRef =
 				toOneReference.getBindableType() == Bindable.BindableType.SINGULAR_ATTRIBUTE
@@ -617,7 +619,6 @@ public <P, F> SqmExpression<F> fk(Path<P> path) {
 					)
 			);
 		}
-
 		return new SqmFkExpression<>( sqmPath );
 	}
 
@@ -2016,6 +2017,16 @@ public JpaExpression<LocalTime> localTime() {
 				);
 	}
 
+	@Override
+	public SqmPath<?> id(Path<?> path) {
+		return ((SqmPath<?>) path).get( EntityIdentifierMapping.ID_ROLE_NAME );
+	}
+
+	@Override
+	public SqmPath<?> version(Path<?> path) {
+		return ((SqmPath<?>) path).get( EntityVersionMapping.VERSION_ROLE_NAME );
+	}
+
 	@Override
 	public <T> SqmFunction<T> function(String name, Class<T> type, Expression<?>[] args) {
 		final BasicType<T> resultType = getTypeConfiguration().standardBasicTypeForJavaType( type );
diff --git a/hibernate-core/src/main/java/org/hibernate/query/sqm/tree/domain/AbstractSqmFrom.java b/hibernate-core/src/main/java/org/hibernate/query/sqm/tree/domain/AbstractSqmFrom.java
@@ -25,6 +25,7 @@
 import org.hibernate.query.criteria.JpaCrossJoin;
 import org.hibernate.query.criteria.JpaCteCriteria;
 import org.hibernate.query.criteria.JpaDerivedJoin;
+import org.hibernate.query.criteria.JpaExpression;
 import org.hibernate.query.criteria.JpaFunctionJoin;
 import org.hibernate.query.criteria.JpaPath;
 import org.hibernate.query.criteria.JpaSelection;
@@ -949,4 +950,9 @@ public JpaSelection<T> alias(String name) {
 		}
 		return super.alias( name );
 	}
+
+	@Override
+	public JpaExpression<?> id() {
+		return nodeBuilder().id( this );
+	}
 }
diff --git a/hibernate-core/src/test/java/org/hibernate/orm/test/query/criteria/CriteriaIdVersionTest.java b/hibernate-core/src/test/java/org/hibernate/orm/test/query/criteria/CriteriaIdVersionTest.java
@@ -0,0 +1,80 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ * Copyright Red Hat Inc. and Hibernate Authors
+ */
+package org.hibernate.orm.test.query.criteria;
+
+import jakarta.persistence.CascadeType;
+import jakarta.persistence.Entity;
+import jakarta.persistence.Id;
+import jakarta.persistence.ManyToOne;
+import jakarta.persistence.Version;
+import org.hibernate.testing.orm.junit.DomainModel;
+import org.hibernate.testing.orm.junit.SessionFactory;
+import org.hibernate.testing.orm.junit.SessionFactoryScope;
+import org.junit.jupiter.api.Test;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+
+@SessionFactory
+@DomainModel(annotatedClasses = CriteriaIdVersionTest.Thing.class)
+class CriteriaIdVersionTest {
+	@Test
+	void test(SessionFactoryScope scope) {
+		scope.getSessionFactory().getSchemaManager().truncate();
+		scope.inTransaction( session -> {
+			session.persist( new Thing() );
+		} );
+		scope.inSession( session -> {
+			var cb = session.getCriteriaBuilder();
+			var cq = cb.createQuery( Long.class );
+			var root = cq.from( Thing.class );
+			cq.select( cb.id(root).as( Long.class ) );
+			assertEquals( 2L, session.createSelectionQuery( cq ).getSingleResult() );
+		} );
+		scope.inSession( session -> {
+			var cb = session.getCriteriaBuilder();
+			var cq = cb.createQuery( Long.class );
+			var root = cq.from( Thing.class );
+			cq.select( cb.version(root).as( Long.class ) );
+			assertEquals( 3L, session.createSelectionQuery( cq ).getSingleResult() );
+		} );
+		scope.inSession( session -> {
+			var cb = session.getCriteriaBuilder();
+			var cq = cb.createQuery( Long.class );
+			var root = cq.from( Thing.class );
+			cq.select( root.id().asLong() );
+			assertEquals( 2L, session.createSelectionQuery( cq ).getSingleResult() );
+		} );
+	}
+
+	@Test
+	void testPath(SessionFactoryScope scope) {
+		scope.getSessionFactory().getSchemaManager().truncate();
+		scope.inTransaction( session -> {
+			Thing thing = new Thing();
+			Thing otherThing = new Thing();
+			otherThing.id = 5;
+			thing.other = otherThing;
+			session.persist( thing );
+		} );
+		scope.inSession( session -> {
+			var cb = session.getCriteriaBuilder();
+			var cq = cb.createQuery( Long.class );
+			var root = cq.from( Thing.class );
+			cq.select( cb.id( root.get("other") ).as( Long.class ) );
+			cq.where( root.get("other").isNotNull() );
+			assertEquals( 5L, session.createSelectionQuery( cq ).getSingleResult() );
+		} );
+	}
+
+	@Entity
+	static class Thing {
+		@Id
+		long id = 2;
+		@Version
+		long version = 3;
+		@ManyToOne(cascade = CascadeType.PERSIST)
+		Thing other;
+	}
+}

Original file line number	Diff line number	Diff line change
`@@ -261,7 +261,7 @@ public <Y> SingularPersistentAttribute<? super J, Y> getVersion(Class<Y> javaTyp`
`261`	`261`	`}`
`262`	`262`
`263`	`263`	`@Override`
`264`		`- public SingularPersistentAttribute<? super J, ?> findVersionAttribute() {`
	`264`	`+ public SqmSingularPersistentAttribute<? super J, ?> findVersionAttribute() {`
`265`	`265`	`if ( versionAttribute != null ) {`
`266`	`266`	`return versionAttribute;`
`267`	`267`	`}`
Original file line number	Diff line number	Diff line change
`@@ -324,4 +324,7 @@ default <X> JpaJoin<?, X> join(JpaCteCriteria<X> cte, org.hibernate.query.common`
`324`	`324`
`325`	`325`	`@Override`
`326`	`326`	`<S extends T> JpaTreatedFrom<O,T,S> treatAs(EntityDomainType<S> treatJavaType);`
	`327`	`+`
	`328`	`+ @Incubating`
	`329`	`+ JpaExpression<?> id();`
`327`	`330`	`}`
Original file line number	Diff line number	Diff line change
`@@ -3472,7 +3472,8 @@ public SqmPath<?> visitEntityIdReference(HqlParser.EntityIdReferenceContext ctx)`
`3472`	`3472`	`return sqmPath.get( identifierDescriptor.getPathName(), true );`
`3473`	`3473`	`}`
`3474`	`3474`	`else if ( sqmPath instanceof SqmAnyValuedSimplePath<?> ) {`
`3475`		`- return sqmPath.resolvePathPart( AnyKeyPart.KEY_NAME, true, processingStateStack.getCurrent().getCreationState() );`
	`3475`	`+ return sqmPath.resolvePathPart( AnyKeyPart.KEY_NAME, true,`
	`3476`	`+ processingStateStack.getCurrent().getCreationState() );`
`3476`	`3477`	`}`
`3477`	`3478`	`else {`
`3478`	`3479`	`throw new FunctionArgumentException( "Argument '" + sqmPath.getNavigablePath()`
Original file line number	Diff line number	Diff line change
`@@ -25,6 +25,7 @@`
`25`	`25`	`import org.hibernate.query.criteria.JpaCrossJoin;`
`26`	`26`	`import org.hibernate.query.criteria.JpaCteCriteria;`
`27`	`27`	`import org.hibernate.query.criteria.JpaDerivedJoin;`
	`28`	`+import org.hibernate.query.criteria.JpaExpression;`
`28`	`29`	`import org.hibernate.query.criteria.JpaFunctionJoin;`
`29`	`30`	`import org.hibernate.query.criteria.JpaPath;`
`30`	`31`	`import org.hibernate.query.criteria.JpaSelection;`
`@@ -949,4 +950,9 @@ public JpaSelection<T> alias(String name) {`
`949`	`950`	`}`
`950`	`951`	`return super.alias( name );`
`951`	`952`	`}`
	`953`	`+`
	`954`	`+ @Override`
	`955`	`+ public JpaExpression<?> id() {`
	`956`	`+ return nodeBuilder().id( this );`
	`957`	`+ }`
`952`	`958`	`}`