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

more query space javadoc improvements

This commit is contained in:
Gavin 2023-01-22 21:25:13 +01:00
parent 662594fd5f
commit e0e3921503
3 changed files with 27 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
hibernate-core/src/main/java/org/hibernate/annotations/NamedNativeQuery.java
View File

@ -158,8 +158,10 @@ public @interface NamedNativeQuery {
/** /**
* The {@linkplain org.hibernate.query.SynchronizeableQuery query spaces} * The {@linkplain org.hibernate.query.SynchronizeableQuery query spaces}
* involved in this query. * involved in this query.
* <p>
* Typically, the names of tables which are referenced by the query.
* *
* @see org.hibernate.query.SynchronizeableQuery * @see org.hibernate.query.SynchronizeableQuery#addSynchronizedQuerySpace
* @see org.hibernate.jpa.HibernateHints#HINT_NATIVE_SPACES * @see org.hibernate.jpa.HibernateHints#HINT_NATIVE_SPACES
* @see Synchronize * @see Synchronize
*/ */

7
hibernate-core/src/main/java/org/hibernate/jpa/HibernateHints.java
View File

@ -126,7 +126,7 @@ public interface HibernateHints {
/** /**
* Hint for specifying the * Hint for specifying the
* {@link org.hibernate.query.SynchronizeableQuery query spaces} * {@linkplain org.hibernate.query.SynchronizeableQuery query spaces}
* that affect the results of a native query. * that affect the results of a native query.
* <p> * <p>
* Passed value can be any of: * Passed value can be any of:
@ -135,8 +135,11 @@ public interface HibernateHints {
* <li>an array of the spaces, or * <li>an array of the spaces, or
* <li>a string with a whitespace-separated list of the spaces. * <li>a string with a whitespace-separated list of the spaces.
* </ul> * </ul>
* <p>
* Typically, these are the names of tables which are referenced by
* the query.
* *
* @see org.hibernate.query.SynchronizeableQuery * @see org.hibernate.query.SynchronizeableQuery#addSynchronizedQuerySpace
* @see #HINT_FLUSH_MODE * @see #HINT_FLUSH_MODE
* @see org.hibernate.annotations.NamedNativeQuery#querySpaces * @see org.hibernate.annotations.NamedNativeQuery#querySpaces
*/ */

28
hibernate-core/src/main/java/org/hibernate/query/SynchronizeableQuery.java
View File

@ -50,26 +50,35 @@ import org.hibernate.MappingException;
*/ */
public interface SynchronizeableQuery { public interface SynchronizeableQuery {
/** /**
* Obtain the list of query spaces the query is synchronized on. * Obtain the list of query spaces this query is synchronized with.
* *
* @return The list of query spaces upon which the query is synchronized. * @return The list of query spaces upon which the query is synchronized.
*/ */
Collection<String> getSynchronizedQuerySpaces(); Collection<String> getSynchronizedQuerySpaces();
/** /**
* Adds a query space. * Add a query space. The effect of this call is to:
* <ul>
* <li>force an auto-flush if any entity associated with the current session
* and mapped to the given query space has pending changes which have not
* yet been synchronized with the database, and
* <li>if the result set of this query is cached, mark it for invalidation
* when any entity mapped to the given query space is synchronized with
* the database in any session.
* </ul>
* *
* @param querySpace The query space to be auto-flushed for this query. * @param querySpace The name of the query space, usually the name of a database table.
* *
* @return {@code this}, for method chaining * @return {@code this}, for method chaining
*/ */
SynchronizeableQuery addSynchronizedQuerySpace(String querySpace); SynchronizeableQuery addSynchronizedQuerySpace(String querySpace);
/** /**
* Adds an entity name for (a) auto-flush checking and (b) query result cache invalidation checking. Same as * Add all query spaces associated with the entity with the given names.
* {@link #addSynchronizedQuerySpace} for all tables associated with the given entity. * <p>
* Same as {@link #addSynchronizedQuerySpace} for all tables mapped by the given entity.
* *
* @param entityName The name of the entity upon whose defined query spaces we should additionally synchronize. * @param entityName The name of an entity.
* *
* @return {@code this}, for method chaining * @return {@code this}, for method chaining
* *
@ -78,10 +87,11 @@ public interface SynchronizeableQuery {
SynchronizeableQuery addSynchronizedEntityName(String entityName) throws MappingException; SynchronizeableQuery addSynchronizedEntityName(String entityName) throws MappingException;
/** /**
* Adds an entity for (a) auto-flush checking and (b) query result cache invalidation checking. Same as * Add all query spaces associated with the entity with the given type.
* {@link #addSynchronizedQuerySpace} for all tables associated with the given entity. * <p>
* Same as {@link #addSynchronizedQuerySpace} for all tables mapped by the given entity.
* *
* @param entityClass The class of the entity upon whose defined query spaces we should additionally synchronize. * @param entityClass The class of the entity.
* *
* @return {@code this}, for method chaining * @return {@code this}, for method chaining
* *