HHH-18190 - Remove @LazyCollection

Author: sebersole

documentation/src/main/asciidoc/userguide/chapters/fetching/Fetching.adoc

@@ -597,72 +597,3 @@ include::{extrasdir}/fetching-strategies-fetch-mode-join-example.sql[]
 ====
 
 This time, there was no secondary query because the child collection was loaded along with the parent entity.
-
-[[fetching-LazyCollection]]
-=== `@LazyCollection`
-
-The https://docs.jboss.org/hibernate/orm/{majorMinorVersion}/javadocs/org/hibernate/annotations/LazyCollection.html[`@LazyCollection`] annotation is used to specify the lazy fetching behavior of a given collection.
-The possible values are given by the `https://docs.jboss.org/hibernate/orm/{majorMinorVersion}/javadocs/org/hibernate/annotations/LazyCollectionOption.html[LazyCollectionOption]` enumeration:
-
-`TRUE`:: Load it when the state is requested.
-`FALSE`:: Eagerly load it.
-`EXTRA`:: Prefer extra queries over full collection loading.
-
-The `TRUE` and `FALSE` values are deprecated since you should be using the Jakarta Persistence {jpaJavadocUrlPrefix}FetchType.html[`FetchType`] attribute of the <<annotations-jpa-elementcollection>>, <<annotations-jpa-onetomany>>, or <<annotations-jpa-manytomany>> collection.
-
-The `EXTRA` value has no equivalent in the Jakarta Persistence specification, and it's used to avoid loading the entire collection even when the collection is accessed for the first time.
-Each element is fetched individually using a secondary query.
-
-[[fetching-LazyCollection-domain-model-example]]
-.`LazyCollectionOption.EXTRA` mapping example
-====
-[source, java, indent=0]
-----
-include::{example-dir-fetching}/LazyCollectionTest.java[tags=fetching-LazyCollection-domain-model-example]
-----
-====
-
-[NOTE]
-====
-`LazyCollectionOption.EXTRA` only works for ordered collections,
-either List(s) that are annotated with @OrderColumn or Map(s).
-
-For bags (e.g. regular List(s) of entities that do not preserve any certain ordering),
-the `@LazyCollection(LazyCollectionOption.EXTRA)` behaves like any other `FetchType.LAZY` collection
-(the collection is fetched entirely upon being accessed for the first time).
-====
-
-Now, considering we have the following entities:
-
-[[fetching-LazyCollection-persist-example]]
-.`LazyCollectionOption.EXTRA` Domain Model example
-====
-[source, java, indent=0]
-----
-include::{example-dir-fetching}/LazyCollectionTest.java[tags=fetching-LazyCollection-persist-example]
-----
-====
-
-When fetching the `employee` collection entries by their position in the `List`,
-Hibernate generates the following SQL statements:
-
-[[fetching-LazyCollection-select-example]]
-.`LazyCollectionOption.EXTRA` fetching example
-====
-[source, java, indent=0]
-----
-include::{example-dir-fetching}/LazyCollectionTest.java[tags=fetching-LazyCollection-select-example]
-----
-
-[source, SQL, indent=0]
-----
-include::{extrasdir}/fetching-LazyCollection-select-example.sql[]
-----
-====
-
-[WARNING]
-====
-Therefore, the child entities were fetched one after the other without triggering a full collection initialization.
-
-For this reason, caution is advised since accessing all elements using `LazyCollectionOption.EXTRA` can lead to N + 1 query issue.
-====

hibernate-core/src/main/java/org/hibernate/annotations/LazyCollection.java

@@ -39,8 +39,6 @@
 import org.hibernate.annotations.Formula;
 import org.hibernate.annotations.HQLSelect;
 import org.hibernate.annotations.Immutable;
-import org.hibernate.annotations.LazyCollection;
-import org.hibernate.annotations.LazyCollectionOption;
 import org.hibernate.annotations.LazyGroup;
 import org.hibernate.annotations.ListIndexBase;
 import org.hibernate.annotations.ListIndexJavaType;
@@ -150,7 +148,6 @@
 import static jakarta.persistence.AccessType.PROPERTY;
 import static jakarta.persistence.ConstraintMode.NO_CONSTRAINT;
 import static jakarta.persistence.ConstraintMode.PROVIDER_DEFAULT;
-import static jakarta.persistence.FetchType.EAGER;
 import static jakarta.persistence.FetchType.LAZY;
 import static org.hibernate.boot.model.internal.AnnotatedClassType.EMBEDDABLE;
 import static org.hibernate.boot.model.internal.AnnotatedClassType.NONE;
@@ -1559,21 +1556,8 @@ private void setHibernateFetchMode(org.hibernate.annotations.FetchMode fetchMode
 	@SuppressWarnings("deprecation")
 	private void handleLazy() {
 		final FetchType jpaFetchType = getJpaFetchType();
-		final LazyCollection lazyCollectionAnnotation = property.getDirectAnnotationUsage( LazyCollection.class );
-		if ( lazyCollectionAnnotation != null ) {
-			final LazyCollectionOption option = lazyCollectionAnnotation.value();
-			boolean eager = option == LazyCollectionOption.FALSE;
-			if ( !eager && jpaFetchType == EAGER ) {
-				throw new AnnotationException("Collection '" + safeCollectionRole()
-						+ "' is marked 'fetch=EAGER' and '@LazyCollection(" + option + ")'");
-			}
-			collection.setLazy( !eager );
-			collection.setExtraLazy( option == LazyCollectionOption.EXTRA );
-		}
-		else {
-			collection.setLazy( jpaFetchType == LAZY );
-			collection.setExtraLazy( false );
-		}
+		collection.setLazy( jpaFetchType == LAZY );
+		collection.setExtraLazy( false );
 	}
 
 	private FetchType getJpaFetchType() {

hibernate-core/src/main/java/org/hibernate/annotations/LazyCollectionOption.java

@@ -366,10 +366,6 @@ public interface HibernateAnnotations {
 			JoinFormula.class,
 			JoinFormulaAnnotation.class
 	);
-	OrmAnnotationDescriptor<LazyCollection, LazyCollectionAnnotation> LAZY_COLLECTION = new OrmAnnotationDescriptor<>(
-			LazyCollection.class,
-			LazyCollectionAnnotation.class
-	);
 	OrmAnnotationDescriptor<LazyGroup, LazyGroupAnnotation> LAZY_GROUP = new OrmAnnotationDescriptor<>(
 			LazyGroup.class,
 			LazyGroupAnnotation.class

hibernate-core/src/main/java/org/hibernate/boot/model/internal/CollectionBinder.java

@@ -47,31 +47,6 @@ public void testLazy() {
 		s.close();
 	}
 
-	@Test
-	public void testExtraLazy() {
-		Session s;
-		Transaction tx;
-		s = openSession();
-		tx = s.beginTransaction();
-		Person p = new Person( "Gavin", "King", "JBoss Inc" );
-		Stay stay = new Stay( p, new Date(), new Date(), "A380", "Blah", "Blah" );
-		p.getOrderedStay().add( stay );
-		s.persist( p );
-		tx.commit();
-		s.clear();
-		tx = s.beginTransaction();
-		p = (Person) s.createQuery( "from Person p where p.firstName = :name" )
-				.setParameter( "name", "Gavin" ).uniqueResult();
-		assertFalse( Hibernate.isInitialized( p.getOrderedStay() ) );
-		assertEquals( 1, p.getOrderedStay().size() );
-		assertFalse( Hibernate.isInitialized( p.getOrderedStay() ) );
-		assertEquals( "A380", p.getOrderedStay().get(0).getVessel() );
-		assertFalse( Hibernate.isInitialized( p.getOrderedStay() ) );
-		s.remove( p );
-		tx.commit();
-		s.close();
-	}
-
 	@Test
 	public void testHibernateFetchingLazy() {
 		try(Session s = openSession()) {
@@ -95,7 +70,7 @@ public void testHibernateFetchingLazy() {
 						.setParameter( "name", "Gavin" ).uniqueResult();
 				assertFalse( Hibernate.isInitialized( p.getOldStays() ) );
 				assertEquals( 1, p.getOldStays().size() );
-				assertFalse( "lazy extra is failing", Hibernate.isInitialized( p.getOldStays() ) );
+				assertTrue( Hibernate.isInitialized( p.getOldStays() ) );
 				s.clear();
 				stay = (Stay) s.get( Stay.class, stay.getId() );
 				assertTrue( !Hibernate.isInitialized( stay.getOldPerson() ) );

hibernate-core/src/main/java/org/hibernate/boot/models/HibernateAnnotations.java

@@ -7,11 +7,16 @@
 
 //$Id$
 package org.hibernate.orm.test.annotations.fetch;
+
 import java.io.Serializable;
 import java.util.ArrayList;
 import java.util.Collection;
 import java.util.Date;
 import java.util.List;
+
+import org.hibernate.annotations.Fetch;
+import org.hibernate.annotations.FetchMode;
+
 import jakarta.persistence.CascadeType;
 import jakarta.persistence.Entity;
 import jakarta.persistence.FetchType;
@@ -21,11 +26,6 @@
 import jakarta.persistence.OrderColumn;
 import jakarta.persistence.Table;
 
-import org.hibernate.annotations.Fetch;
-import org.hibernate.annotations.FetchMode;
-import org.hibernate.annotations.LazyCollection;
-import org.hibernate.annotations.LazyCollectionOption;
-
 
 /**
  * @author Emmanuel Bernard
@@ -101,7 +101,6 @@ public void setStays(List<Stay> stays) {
 	}
 
 	@OneToMany(cascade=CascadeType.ALL, mappedBy = "oldPerson")
-	@LazyCollection(LazyCollectionOption.EXTRA)
 	@Fetch(FetchMode.SUBSELECT)
 	public Collection<Stay> getOldStays() {
 		return oldStays;
@@ -122,7 +121,6 @@ public void setVeryOldStays(Collection<Stay> veryOldStays) {
 	}
 
 	@OneToMany(cascade=CascadeType.ALL)
-	@LazyCollection(LazyCollectionOption.EXTRA)
 	@Fetch(FetchMode.SUBSELECT)
 	@OrderColumn(name="orderedStayIndex")
 	public List<Stay> getOrderedStay() {

hibernate-core/src/main/java/org/hibernate/boot/models/annotations/internal/LazyCollectionAnnotation.java

@@ -28,7 +28,6 @@ public class Customers implements Serializable {
 	private int customerID;
 
 	@OneToMany(mappedBy="owner", cascade= CascadeType.ALL, targetEntity=ShoppingBaskets.class)
-	@org.hibernate.annotations.LazyCollection(org.hibernate.annotations.LazyCollectionOption.TRUE)
 	private java.util.Set shoppingBasketses = new java.util.HashSet();
 
 	public void setCustomerID(int value) {

hibernate-core/src/test/java/org/hibernate/orm/test/annotations/fetch/FetchingTest.java

@@ -37,7 +37,6 @@ public class ShoppingBaskets implements Serializable {
 	private java.util.Date basketDatetime;
 
 	@OneToMany(mappedBy="shoppingBaskets", cascade=CascadeType.ALL, targetEntity=BasketItems.class)
-	@org.hibernate.annotations.LazyCollection(org.hibernate.annotations.LazyCollectionOption.TRUE)
 	private java.util.Set items = new java.util.HashSet();
 
 	public void setBasketDatetime(java.util.Date value) {