Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

various minor improvements around Query hierarchy #9877

Merged
merged 4 commits into from
Mar 19, 2025
Merged

various minor improvements around Query hierarchy #9877

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
0f92b3a
HHH-19271 support HINT_FETCH_PROFILE in SelectionQuery
gavinking Mar 19, 2025
8b4ddb2
add @apiNotes about purpose of JPA hints
gavinking Mar 19, 2025
7946034
minor javadoc improvements
gavinking Mar 19, 2025
264bdce
add missing @Deprecated and @Override annotations
gavinking Mar 19, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions hibernate-core/src/main/java/org/hibernate/Session.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1266,6 +1266,25 @@ public interface Session extends SharedSessionContract, EntityManager {
*/
void addEventListeners(SessionEventListener... listeners);

/**
* Set a hint. The hints understood by Hibernate are enumerated by
* {@link org.hibernate.jpa.AvailableHints}.
*
* @see org.hibernate.jpa.HibernateHints
* @see org.hibernate.jpa.SpecHints
*
* @apiNote Hints are a
* {@linkplain jakarta.persistence.EntityManager#setProperty
* JPA-standard way} to control provider-specific behavior of the
* {@code EntityManager}. Clients of the native API defined by
* Hibernate should make use of type-safe operations of this
* interface. For example, {@link #enableFetchProfile(String)}
* should be used in preference to the hint
* {@link org.hibernate.jpa.HibernateHints#HINT_FETCH_PROFILE}.
*/
@Override
void setProperty(String propertyName, Object value);

/**
* Create a new mutable instance of {@link EntityGraph}, with only
* a root node, allowing programmatic definition of the graph from
Expand Down
5 changes: 4 additions & 1 deletion hibernate-core/src/main/java/org/hibernate/jpa/HibernateHints.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -166,10 +166,13 @@ public interface HibernateHints {

/**
* Hint to enable a fetch profile for a given
* {@link jakarta.persistence.EntityManager#setProperty(String, Object) EntityManager}.
* {@link jakarta.persistence.EntityManager#setProperty(String, Object) EntityManager}
* or {@link jakarta.persistence.Query#setHint(String, Object) Query}.
*
* @see org.hibernate.Session#enableFetchProfile(String)
* @see org.hibernate.query.SelectionQuery#enableFetchProfile(String)
* @see jakarta.persistence.EntityManager#setProperty(String, Object)
* @see jakarta.persistence.Query#setHint(String, Object)
*/
String HINT_FETCH_PROFILE = "org.hibernate.fetchProfile";

Expand Down
12 changes: 6 additions & 6 deletions hibernate-core/src/main/java/org/hibernate/procedure/ProcedureCall.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -255,28 +255,28 @@ default void close() {
@Override
<T> ProcedureCall setParameter( Parameter<T> param, T value);

@Override
@Override @Deprecated
ProcedureCall setParameter(Parameter<Calendar> param, Calendar value, TemporalType temporalType);

@Override
@Override @Deprecated
ProcedureCall setParameter(Parameter<Date> param, Date value, TemporalType temporalType);

@Override
ProcedureCall setParameter(String name, Object value);

@Override
@Override @Deprecated
ProcedureCall setParameter(String name, Calendar value, TemporalType temporalType);

@Override
@Override @Deprecated
ProcedureCall setParameter(String name, Date value, TemporalType temporalType);

@Override
ProcedureCall setParameter(int position, Object value);

@Override
@Override @Deprecated
ProcedureCall setParameter(int position, Calendar value, TemporalType temporalType);

@Override
@Override @Deprecated
ProcedureCall setParameter(int position, Date value, TemporalType temporalType);

@Override @Deprecated(since = "7")
Expand Down
16 changes: 6 additions & 10 deletions hibernate-core/src/main/java/org/hibernate/procedure/internal/ProcedureCallImpl.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,8 +78,6 @@
import org.hibernate.type.BasicTypeReference;
import org.hibernate.type.spi.TypeConfiguration;

import org.jboss.logging.Logger;

import jakarta.persistence.CacheRetrieveMode;
import jakarta.persistence.CacheStoreMode;
import jakarta.persistence.FlushModeType;
Expand Down Expand Up @@ -107,7 +105,6 @@
public class ProcedureCallImpl<R>
extends AbstractQuery<R>
implements ProcedureCallImplementor<R>, ResultContext {
private static final Logger LOG = Logger.getLogger( ProcedureCallImpl.class );

private final String procedureName;

Expand Down Expand Up @@ -656,7 +653,6 @@ private ProcedureOutputsImpl buildOutputs() {
}
}

LOG.debugf( "Preparing procedure call : %s", call);
final String sqlString = call.getSqlString();
final CallableStatement statement = (CallableStatement) getSession()
.getJdbcCoordinator()
Expand Down Expand Up @@ -1207,7 +1203,7 @@ public <P> ProcedureCallImplementor<R> setParameter(int position, P value, Binda
return this;
}

@Override
@Override @Deprecated
public ProcedureCallImplementor<R> setParameter(
Parameter<Calendar> parameter,
Calendar value,
Expand All @@ -1216,31 +1212,31 @@ public ProcedureCallImplementor<R> setParameter(
return this;
}

@Override
@Override @Deprecated
public ProcedureCallImplementor<R> setParameter(Parameter<Date> parameter, Date value, TemporalType temporalPrecision) {
super.setParameter( parameter, value, temporalPrecision );
return this;
}

@Override
@Override @Deprecated
public ProcedureCallImplementor<R> setParameter(String name, Calendar value, TemporalType temporalPrecision) {
super.setParameter( name, value, temporalPrecision );
return this;
}

@Override
@Override @Deprecated
public ProcedureCallImplementor<R> setParameter(String name, Date value, TemporalType temporalPrecision) {
super.setParameter( name, value, temporalPrecision );
return this;
}

@Override
@Override @Deprecated
public ProcedureCallImplementor<R> setParameter(int position, Calendar value, TemporalType temporalPrecision) {
super.setParameter( position, value, temporalPrecision );
return this;
}

@Override
@Override @Deprecated
public ProcedureCallImplementor<R> setParameter(int position, Date value, TemporalType temporalPrecision) {
super.setParameter( position, value, temporalPrecision );
return this;
Expand Down
12 changes: 6 additions & 6 deletions hibernate-core/src/main/java/org/hibernate/procedure/spi/ProcedureCallImplementor.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,28 +51,28 @@ default List<R> getResultList() {
@Override
<T> ProcedureCallImplementor<R> setParameter(Parameter<T> param, T value);

@Override
@Override @Deprecated
ProcedureCallImplementor<R> setParameter(Parameter<Calendar> param, Calendar value, TemporalType temporalType);

@Override
@Override @Deprecated
ProcedureCallImplementor<R> setParameter(Parameter<Date> param, Date value, TemporalType temporalType);

@Override
ProcedureCallImplementor<R> setParameter(String name, Object value);

@Override
@Override @Deprecated
ProcedureCallImplementor<R> setParameter(String name, Calendar value, TemporalType temporalType);

@Override
@Override @Deprecated
ProcedureCallImplementor<R> setParameter(String name, Date value, TemporalType temporalType);

@Override
ProcedureCallImplementor<R> setParameter(int position, Object value);

@Override
@Override @Deprecated
ProcedureCallImplementor<R> setParameter(int position, Calendar value, TemporalType temporalType);

@Override
@Override @Deprecated
ProcedureCallImplementor<R> setParameter(int position, Date value, TemporalType temporalType);

@Override
Expand Down
33 changes: 33 additions & 0 deletions hibernate-core/src/main/java/org/hibernate/query/CommonQueryContract.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -180,6 +180,15 @@ public interface CommonQueryContract {
*
* @see org.hibernate.jpa.HibernateHints
* @see org.hibernate.jpa.SpecHints
*
* @apiNote Hints are a
* {@linkplain jakarta.persistence.Query#setHint(String, Object)
* JPA-standard way} to control provider-specific behavior
* affecting execution of the query. Clients of the native API
* defined by Hibernate should make use of type-safe operations
* of this interface and of its subtypes. For example,
* {@link SelectionQuery#setCacheRegion} is preferred over
* {@link org.hibernate.jpa.HibernateHints#HINT_CACHE_REGION}.
*/
CommonQueryContract setHint(String hintName, Object value);

Expand Down Expand Up @@ -213,17 +222,26 @@ public interface CommonQueryContract {
/**
* Bind an {@link Instant} to the named query parameter using just the
* portion indicated by the given {@link TemporalType}.
*
* @deprecated since {@link TemporalType} is deprecated
*/
@Deprecated(since = "7")
CommonQueryContract setParameter(String parameter, Instant value, TemporalType temporalType);

/**
* @see jakarta.persistence.Query#setParameter(String, Calendar, TemporalType)
*
* @deprecated since {@link TemporalType} is deprecated
*/
@Deprecated(since = "7")
CommonQueryContract setParameter(String parameter, Calendar value, TemporalType temporalType);

/**
* @see jakarta.persistence.Query#setParameter(String, Date, TemporalType)
*
* @deprecated since {@link TemporalType} is deprecated
*/
@Deprecated(since = "7")
CommonQueryContract setParameter(String parameter, Date value, TemporalType temporalType);

/**
Expand Down Expand Up @@ -256,17 +274,26 @@ public interface CommonQueryContract {
/**
* Bind an {@link Instant} to an ordinal query parameter using just the
* portion indicated by the given {@link TemporalType}.
*
* @deprecated since {@link TemporalType} is deprecated
*/
@Deprecated(since = "7")
CommonQueryContract setParameter(int parameter, Instant value, TemporalType temporalType);

/**
* @see jakarta.persistence.Query#setParameter(int, Date, TemporalType)
*
* @deprecated since {@link TemporalType} is deprecated
*/
@Deprecated(since = "7")
CommonQueryContract setParameter(int parameter, Date value, TemporalType temporalType);

/**
* @see jakarta.persistence.Query#setParameter(int, Calendar, TemporalType)
*
* @deprecated since {@link TemporalType} is deprecated
*/
@Deprecated(since = "7")
CommonQueryContract setParameter(int parameter, Calendar value, TemporalType temporalType);

/**
Expand Down Expand Up @@ -320,12 +347,18 @@ public interface CommonQueryContract {

/**
* @see jakarta.persistence.Query#setParameter(Parameter, Calendar, TemporalType)
*
* @deprecated since {@link TemporalType} is deprecated
*/
@Deprecated(since = "7")
CommonQueryContract setParameter(Parameter<Calendar> param, Calendar value, TemporalType temporalType);

/**
* @see jakarta.persistence.Query#setParameter(Parameter, Date, TemporalType)
*
* @deprecated since {@link TemporalType} is deprecated
*/
@Deprecated(since = "7")
CommonQueryContract setParameter(Parameter<Date> param, Date value, TemporalType temporalType);

/**
Expand Down
16 changes: 8 additions & 8 deletions hibernate-core/src/main/java/org/hibernate/query/MutationQuery.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,13 +107,13 @@ public interface MutationQuery extends CommonQueryContract {
@Override
<P> MutationQuery setParameter(String name, P value, BindableType<P> type);

@Override
@Override @Deprecated(since = "7")
MutationQuery setParameter(String name, Instant value, TemporalType temporalType);

@Override
@Override @Deprecated(since = "7")
MutationQuery setParameter(String name, Calendar value, TemporalType temporalType);

@Override
@Override @Deprecated(since = "7")
MutationQuery setParameter(String name, Date value, TemporalType temporalType);

@Override
Expand All @@ -125,13 +125,13 @@ public interface MutationQuery extends CommonQueryContract {
@Override
<P> MutationQuery setParameter(int position, P value, BindableType<P> type);

@Override
@Override @Deprecated(since = "7")
MutationQuery setParameter(int position, Instant value, TemporalType temporalType);

@Override
@Override @Deprecated(since = "7")
MutationQuery setParameter(int position, Date value, TemporalType temporalType);

@Override
@Override @Deprecated(since = "7")
MutationQuery setParameter(int position, Calendar value, TemporalType temporalType);

@Override
Expand All @@ -146,10 +146,10 @@ public interface MutationQuery extends CommonQueryContract {
@Override
<T> MutationQuery setParameter(Parameter<T> param, T value);

@Override
@Override @Deprecated(since = "7")
MutationQuery setParameter(Parameter<Calendar> param, Calendar value, TemporalType temporalType);

@Override
@Override @Deprecated(since = "7")
MutationQuery setParameter(Parameter<Date> param, Date value, TemporalType temporalType);

@Override
Expand Down
16 changes: 8 additions & 8 deletions hibernate-core/src/main/java/org/hibernate/query/NativeQuery.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -708,13 +708,13 @@ interface FetchReturn extends ResultNode {
@Override
<P> NativeQuery<T> setParameter(String name, P val, BindableType<P> type);

@Override
@Override @Deprecated(since = "7")
NativeQuery<T> setParameter(String name, Instant value, TemporalType temporalType);

@Override
@Override @Deprecated(since = "7")
NativeQuery<T> setParameter(String name, Calendar value, TemporalType temporalType);

@Override
@Override @Deprecated(since = "7")
NativeQuery<T> setParameter(String name, Date value, TemporalType temporalType);

@Override
Expand All @@ -726,13 +726,13 @@ interface FetchReturn extends ResultNode {
@Override
<P> NativeQuery<T> setParameter(int position, P val, BindableType<P> type);

@Override
@Override @Deprecated(since = "7")
NativeQuery<T> setParameter(int position, Instant value, TemporalType temporalType);

@Override
@Override @Deprecated(since = "7")
NativeQuery<T> setParameter(int position, Calendar value, TemporalType temporalType);

@Override
@Override @Deprecated(since = "7")
NativeQuery<T> setParameter(int position, Date value, TemporalType temporalType);

@Override
Expand All @@ -747,10 +747,10 @@ interface FetchReturn extends ResultNode {
@Override
<P> NativeQuery<T> setParameter(Parameter<P> param, P value);

@Override
@Override @Deprecated(since = "7")
NativeQuery<T> setParameter(Parameter<Calendar> param, Calendar value, TemporalType temporalType);

@Override
@Override @Deprecated(since = "7")
NativeQuery<T> setParameter(Parameter<Date> param, Date value, TemporalType temporalType);

@Override
Expand Down
Loading
Loading