Hibernate
/
hibernate-orm
mirror of https://github.com/hibernate/hibernate-orm
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

HHH-17773 more Javadoc for new pagination APIs

This commit is contained in:
Gavin King 2024-03-12 23:05:37 +01:00
parent 276a93e95e
commit 2451268f16
1 changed files with 17 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
hibernate-core/src/main/java/org/hibernate/query/SelectionQuery.java
View File

@ -80,10 +80,23 @@ import org.hibernate.graph.GraphSemantic;
* </ul>
* <p>
* The special built-in fetch profile named
* {@value DefaultFetchProfile#HIBERNATE_DEFAULT_PROFILE} adds
* a fetch join for every {@link jakarta.persistence.FetchType#EAGER eager}
* {@code @ManyToOne} or {@code @OneToOne} association belonging to an entity
* returned by the query.
* {@value DefaultFetchProfile#HIBERNATE_DEFAULT_PROFILE} adds a fetch join for
* every {@link jakarta.persistence.FetchType#EAGER eager} {@code @ManyToOne} or
* {@code @OneToOne} association belonging to an entity returned by the query.
* <p>
* Finally, two alternative approaches to pagination are available:
* <ol>
* <li>
* The operations and {@link #setOrder(List)} and {@link #setPage(Page)}, together
* with {@link Order} and {@link Page}, provide a streamlined API for offset-based
* pagination, at a slightly higher semantic level than the ancient but dependable
* {@link #setFirstResult(int)} and {@link #setMaxResults(int)}.
* <li>
* On the other hand, {@link KeyedPage} and {@link KeyedResultList}, along with
* {@link #getKeyedResultList(KeyedPage)}, provide for <em>key-based pagination</em>,
* which can help eliminate missed or duplicate results when data is modified
* between page requests.
* </ol>
*
* @author Steve Ebersole
*/