Top Methods
org.hibernate.query.sqm

public Interface SqmSelectionQuery<R>

extends SqmQuery, SelectionQuery<R>
Known Direct Subinterfaces
org.hibernate.query.sqm.spi.SqmSelectionQueryImplementor
Imports
java.time.Instant, java.util.Calendar, .Collection, .Date, .Map, org.hibernate.CacheMode, .FlushMode, org.hibernate.query.BindableType, .QueryParameter, .SelectionQuery, org.hibernate.query.spi.SqmQuery, jakarta.persistence.Parameter, .TemporalType
Author
Steve Ebersole

Method Summary

Modifier and TypeMethod and Description
public SqmSelectionQuery<R>
setCacheable(boolean cacheable)

Redeclares org.hibernate.query.SelectionQuery.setCacheable.

Enable/disable second level query (result) caching for this query.
public SqmSelectionQuery<R>
setCacheMode(CacheMode cacheMode)

Redeclares org.hibernate.query.SelectionQuery.setCacheMode.

Set the current CacheMode in effect for this query.
public SqmSelectionQuery<R>
setCacheRegion(String cacheRegion)

Redeclares org.hibernate.query.SelectionQuery.setCacheRegion.

Set the name of the cache region where query results should be cached (assuming isCacheable).
public SqmSelectionQuery<R>
setFetchSize(int
the fetch size hint
fetchSize)

Redeclares org.hibernate.query.SelectionQuery.setFetchSize.

Sets a JDBC fetch size hint for the query.
public SqmSelectionQuery<R>
setHibernateFlushMode(FlushMode flushMode)

Redeclares org.hibernate.query.spi.SqmQuery.setHibernateFlushMode, org.hibernate.query.SelectionQuery.setHibernateFlushMode.

Set the current FlushMode in effect for this query.
public SqmSelectionQuery<R>
setParameter(String name, Object value)

Redeclares org.hibernate.query.spi.SqmQuery.setParameter, org.hibernate.query.SelectionQuery.setParameter.

Bind the given argument to a named query parameter.
public <P> SqmSelectionQuery<R>
setParameter(String name, P value, Class<P> type)

Redeclares org.hibernate.query.spi.SqmQuery.setParameter, org.hibernate.query.SelectionQuery.setParameter.

Bind the given argument to a named query parameter using the given Class reference to attempt to infer the BindableType.
public <P> SqmSelectionQuery<R>
setParameter(String name, P value, BindableType<P> type)

Redeclares org.hibernate.query.spi.SqmQuery.setParameter, org.hibernate.query.SelectionQuery.setParameter.

Bind the given argument to a named query parameter using the given BindableType.
public SqmSelectionQuery<R>
setParameter(String name, Instant value, TemporalType temporalType)

Redeclares org.hibernate.query.spi.SqmQuery.setParameter, org.hibernate.query.SelectionQuery.setParameter.

Bind an Instant to the named query parameter using just the portion indicated by the given TemporalType.
public SqmSelectionQuery<R>
setParameter(String name, Calendar value, TemporalType temporalType)

Redeclares org.hibernate.query.spi.SqmQuery.setParameter, org.hibernate.query.SelectionQuery.setParameter.

public SqmSelectionQuery<R>
setParameter(String name, Date value, TemporalType temporalType)

Redeclares org.hibernate.query.spi.SqmQuery.setParameter, org.hibernate.query.SelectionQuery.setParameter.

public SqmSelectionQuery<R>
setParameter(int position, Object value)

Redeclares org.hibernate.query.spi.SqmQuery.setParameter, org.hibernate.query.SelectionQuery.setParameter.

Bind the given argument to an ordinal query parameter.
public <P> SqmSelectionQuery<R>
setParameter(int position, P value, Class<P> type)

Redeclares org.hibernate.query.spi.SqmQuery.setParameter, org.hibernate.query.SelectionQuery.setParameter.

Bind the given argument to an ordinal query parameter using the given Class reference to attempt to infer the BindableType.
public <P> SqmSelectionQuery<R>
setParameter(int position, P value, BindableType<P> type)

Redeclares org.hibernate.query.spi.SqmQuery.setParameter, org.hibernate.query.SelectionQuery.setParameter.

Bind the given argument to an ordinal query parameter using the given BindableType.
public SqmSelectionQuery<R>
setParameter(int position, Instant value, TemporalType temporalType)

Redeclares org.hibernate.query.spi.SqmQuery.setParameter, org.hibernate.query.SelectionQuery.setParameter.

Bind an Instant to an ordinal query parameter using just the portion indicated by the given TemporalType.
public SqmSelectionQuery<R>
setParameter(int position, Date value, TemporalType temporalType)

Redeclares org.hibernate.query.spi.SqmQuery.setParameter, org.hibernate.query.SelectionQuery.setParameter.

public SqmSelectionQuery<R>
setParameter(int position, Calendar value, TemporalType temporalType)

Redeclares org.hibernate.query.spi.SqmQuery.setParameter, org.hibernate.query.SelectionQuery.setParameter.

public <T> SqmSelectionQuery<R>
setParameter(QueryParameter<T>
the query parameter memento
parameter, T
the argument, which might be null
value)

Redeclares org.hibernate.query.spi.SqmQuery.setParameter, org.hibernate.query.SelectionQuery.setParameter.

Bind an argument to the query parameter represented by the given QueryParameter.
public <P> SqmSelectionQuery<R>
setParameter(QueryParameter<P>
the query parameter memento
parameter, P
the argument, which might be null
value, Class<P>
a BindableType representing the type of the parameter
type)

Redeclares org.hibernate.query.spi.SqmQuery.setParameter, org.hibernate.query.SelectionQuery.setParameter.

Bind an argument to the query parameter represented by the given QueryParameter, using the given Class reference to attempt to infer the BindableType to use.
public <P> SqmSelectionQuery<R>
setParameter(QueryParameter<P>
the query parameter memento
parameter, P
the argument, which might be null
val, BindableType<P>
a BindableType representing the type of the parameter
type)

Redeclares org.hibernate.query.spi.SqmQuery.setParameter, org.hibernate.query.SelectionQuery.setParameter.

Bind an argument to the query parameter represented by the given QueryParameter, using the given BindableType.
public <T> SqmSelectionQuery<R>
setParameter(Parameter<T> param, T value)

Redeclares org.hibernate.query.spi.SqmQuery.setParameter, org.hibernate.query.SelectionQuery.setParameter.

public SqmSelectionQuery<R>
setParameter(Parameter<Calendar> param, Calendar value, TemporalType temporalType)

Redeclares org.hibernate.query.spi.SqmQuery.setParameter, org.hibernate.query.SelectionQuery.setParameter.

public SqmSelectionQuery<R>
setParameter(Parameter<Date> param, Date value, TemporalType temporalType)

Redeclares org.hibernate.query.spi.SqmQuery.setParameter, org.hibernate.query.SelectionQuery.setParameter.

public SqmSelectionQuery<R>
setParameterList(String name, Collection<E> values)

Redeclares org.hibernate.query.spi.SqmQuery.setParameterList, org.hibernate.query.SelectionQuery.setParameterList.

Bind multiple arguments to a named query parameter.
public <P> SqmSelectionQuery<R>
setParameterList(String name, Collection<? extends P> values, Class<P> javaType)

Redeclares org.hibernate.query.spi.SqmQuery.setParameterList, org.hibernate.query.SelectionQuery.setParameterList.

Bind multiple arguments to a named query parameter using the given Class reference to attempt to infer the BindableType If unable to infer an appropriate BindableType, fall back to setParameterList(String, Collection).
public <P> SqmSelectionQuery<R>
setParameterList(String name, Collection<? extends P> values, BindableType<P> type)

Redeclares org.hibernate.query.spi.SqmQuery.setParameterList, org.hibernate.query.SelectionQuery.setParameterList.

Bind multiple arguments to a named query parameter using the given BindableType.
public SqmSelectionQuery<R>
setParameterList(String name, Object[] values)

Redeclares org.hibernate.query.spi.SqmQuery.setParameterList, org.hibernate.query.SelectionQuery.setParameterList.

Bind multiple arguments to a named query parameter.
public <P> SqmSelectionQuery<R>
setParameterList(String name, P[] values, Class<P> javaType)

Redeclares org.hibernate.query.spi.SqmQuery.setParameterList, org.hibernate.query.SelectionQuery.setParameterList.

Bind multiple arguments to a named query parameter using the given Class reference to attempt to determine the BindableType to use.
public <P> SqmSelectionQuery<R>
setParameterList(String name, P[] values, BindableType<P> type)

Redeclares org.hibernate.query.spi.SqmQuery.setParameterList, org.hibernate.query.SelectionQuery.setParameterList.

Bind multiple arguments to a named query parameter using the given BindableType.
public SqmSelectionQuery<R>
setParameterList(int position, Collection<E> values)

Redeclares org.hibernate.query.spi.SqmQuery.setParameterList, org.hibernate.query.SelectionQuery.setParameterList.

Bind multiple arguments to an ordinal query parameter.
public <P> SqmSelectionQuery<R>
setParameterList(int position, Collection<? extends P> values, Class<P> javaType)

Redeclares org.hibernate.query.spi.SqmQuery.setParameterList, org.hibernate.query.SelectionQuery.setParameterList.

Bind multiple arguments to an ordinal query parameter using the given Class reference to attempt to infer the BindableType.
public <P> SqmSelectionQuery<R>
setParameterList(int position, Collection<? extends P> values, BindableType<P> type)

Redeclares org.hibernate.query.spi.SqmQuery.setParameterList, org.hibernate.query.SelectionQuery.setParameterList.

Bind multiple arguments to an ordinal query parameter using the given BindableType.
public SqmSelectionQuery<R>
setParameterList(int position, Object[] values)

Redeclares org.hibernate.query.spi.SqmQuery.setParameterList, org.hibernate.query.SelectionQuery.setParameterList.

Bind multiple arguments to an ordinal query parameter.
public <P> SqmSelectionQuery<R>
setParameterList(int position, P[] values, Class<P> javaType)

Redeclares org.hibernate.query.spi.SqmQuery.setParameterList, org.hibernate.query.SelectionQuery.setParameterList.

Bind multiple arguments to an ordinal query parameter using the given Class reference to attempt to infer the BindableType.
public <P> SqmSelectionQuery<R>
setParameterList(int position, P[] values, BindableType<P> type)

Redeclares org.hibernate.query.spi.SqmQuery.setParameterList, org.hibernate.query.SelectionQuery.setParameterList.

Bind multiple arguments to an ordinal query parameter using the given BindableType.
public <P> SqmSelectionQuery<R>
setParameterList(QueryParameter<P>
the parameter memento
parameter, Collection<? extends P>
a collection of arguments
values)

Redeclares org.hibernate.query.spi.SqmQuery.setParameterList, org.hibernate.query.SelectionQuery.setParameterList.

Bind multiple arguments to the query parameter represented by the given QueryParameter.
public <P> SqmSelectionQuery<R>
setParameterList(QueryParameter<P> parameter, Collection<? extends P> values, Class<P> javaType)

Redeclares org.hibernate.query.spi.SqmQuery.setParameterList, org.hibernate.query.SelectionQuery.setParameterList.

Bind multiple arguments to the query parameter represented by the given QueryParameter using the given Class reference to attempt to infer the BindableType to use.
public <P> SqmSelectionQuery<R>
setParameterList(QueryParameter<P> parameter, Collection<? extends P> values, BindableType<P> type)

Redeclares org.hibernate.query.spi.SqmQuery.setParameterList, org.hibernate.query.SelectionQuery.setParameterList.

Bind multiple arguments to the query parameter represented by the given QueryParameter, using the given BindableType.
public <P> SqmSelectionQuery<R>
setParameterList(QueryParameter<P>
the parameter memento
parameter, P[]
a collection of arguments
values)

Redeclares org.hibernate.query.spi.SqmQuery.setParameterList, org.hibernate.query.SelectionQuery.setParameterList.

Bind multiple arguments to the query parameter represented by the given QueryParameter.
public <P> SqmSelectionQuery<R>
setParameterList(QueryParameter<P> parameter, P[] values, Class<P> javaType)

Redeclares org.hibernate.query.spi.SqmQuery.setParameterList, org.hibernate.query.SelectionQuery.setParameterList.

Bind multiple arguments to the query parameter represented by the given QueryParameter using the given Class reference to attempt to infer the BindableType to use.
public <P> SqmSelectionQuery<R>
setParameterList(QueryParameter<P> parameter, P[] values, BindableType<P> type)

Redeclares org.hibernate.query.spi.SqmQuery.setParameterList, org.hibernate.query.SelectionQuery.setParameterList.

Bind multiple arguments to the query parameter represented by the given QueryParameter, using the given the BindableType.
public SqmSelectionQuery<R>
setProperties(Object
any JavaBean or POJO
bean)

Redeclares org.hibernate.query.spi.SqmQuery.setProperties, org.hibernate.query.SelectionQuery.setProperties.

Bind the property values of the given bean to named parameters of the query, matching property names with parameter names and mapping property types to Hibernate types using heuristics.
public SqmSelectionQuery<R>
setProperties(Map<K, V>
a Map of names to arguments
bean)

Redeclares org.hibernate.query.spi.SqmQuery.setProperties, org.hibernate.query.SelectionQuery.setProperties.

Bind the values of the given Map to named parameters of the query, matching key names with parameter names and mapping value types to Hibernate types using heuristics.
public SqmSelectionQuery<R>
setReadOnly(boolean
true indicates that entities and proxies loaded by the query are to be put in read-only mode; false indicates that entities and proxies loaded by the query will be put in modifiable mode
readOnly)

Redeclares org.hibernate.query.SelectionQuery.setReadOnly.

Set the read-only/modifiable mode for entities and proxies loaded by this Query.
public SqmSelectionQuery<R>
setTimeout(int
the timeout in seconds
timeout)

Redeclares org.hibernate.query.CommonQueryContract.setTimeout, org.hibernate.query.SelectionQuery.setTimeout.

Set the query timeout in seconds.
Inherited from org.hibernate.query.SelectionQuery:
disableFetchProfileenableFetchProfilegetCacheModegetCacheRegiongetCacheRetrieveModegetCacheStoreModegetFetchSizegetFirstResultgetHibernateLockModegetLockModegetLockOptionsgetMaxResultsgetResultListgetResultStreamgetSingleResultgetSingleResultOrNullisCacheableisQueryPlanCacheableisReadOnlylistscrollscrollsetAliasSpecificLockModesetCacheRetrieveModesetCacheStoreModesetCommentsetEntityGraphsetFirstResultsetFlushModesetFollowOnLockingsetHibernateLockModesetHintsetLockModesetLockModesetMaxResultssetOrdersetOrdersetPagesetQueryPlanCacheablestreamuniqueResultuniqueResultOptional
Inherited from org.hibernate.query.spi.SqmQuery:
getParameterMetadatagetQueryOptionsgetQueryStringgetSqmStatement