Interface NativeQuery<T>

All Superinterfaces:

CommonQueryContract, MutationQuery, Query, Query<T>, SelectionQuery<T>, Statement, SynchronizeableQuery, TypedQuery<T>

All Known Subinterfaces:

NativeQueryImplementor<R>

public interface NativeQuery<T>
extends SelectionQuery<T>, MutationQuery, SynchronizeableQuery

Within the context of an active session, an instance of this type represents an executable query written in the native SQL dialect of the underlying database. Since Hibernate does not actually understand SQL, it often requires some help in interpreting the semantics of a native SQL query.

Along with the operations inherited from Query, this interface provides control over:

• mapping the result set of the native SQL query, and
• synchronization of the database with state held in memory before execution of the query, via automatic flushing of the session.

A NativeQuery may be obtained from the Session by calling:

• SharedSessionContract.createNativeQuery(String, Class), passing native SQL as a string, or
• SharedSessionContract.createNativeQuery(String, String, Class) passing the native SQL string and the name of a result set mapping defined using SqlResultSetMapping.

A result set mapping may be specified by:

• a named SqlResultSetMapping passed to SharedSessionContract.createNativeQuery(String, String, Class),
• a named SqlResultSetMapping specified using NamedNativeQuery.resultSetMapping() for a named query, or
• by calling the various addEntity(String), addRoot(String, String), addJoin(String, String), addFetch(String, String, String) and addScalar(String) methods of this object.

The third option is a legacy of much older versions of Hibernate and is currently disfavored.

To determine if an automatic flush is required before execution of the query, Hibernate must know which tables affect the query result set. JPA provides no standard way to do this. Instead, this information may be provided via:

• NamedNativeQuery.querySpaces() for a named query, or
• by calling addSynchronizedEntityClass(Class), addSynchronizedEntityName(String), or addSynchronizedQuerySpace(String).

When the affected tables are not known to Hibernate, the behavior depends on whether Hibernate is operating in fully JPA-compliant mode.

• In JPA-compliant mode, FlushModeType.AUTO specifies that the session should be flushed before execution of a native query when the affected tables are not known.
• Otherwise, when Hibernate is not operating in JPA-compliant mode, AUTO specifies that the session is not flushed before execution of a native query, unless the affected tables are known and Hibernate determines that a flush is required.

See Also:

• Query
• SynchronizeableQuery
• SharedSessionContract

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	NativeQuery.CollectionReturn	Allows access to further control how collection returns are mapped back from result sets.
static interface	NativeQuery.FetchReturn	Allows access to further control how join fetch returns are mapped back from result sets.
static interface	NativeQuery.InstantiationResultNode<J>
static interface	NativeQuery.ResultNode	Simple unification interface for all returns from the various addXYZ() methods.
static interface	NativeQuery.ReturnableResultNode	A NativeQuery.ResultNode which can be a query result.
static interface	NativeQuery.ReturnProperty	Allows access to further control how properties within a root or join fetch are mapped back from the result set.
static interface	NativeQuery.RootReturn	Allows access to further control how root returns are mapped back from result sets.

Method Summary

Modifier and Type	Method	Description
NativeQuery<T>	addAttributeResult(String columnAlias, SingularAttribute attribute)	Deprecated. Use ResultSetMapping, or similar approach pending the outcome of this Jakarta Persistence request.
NativeQuery<T>	addAttributeResult(String columnAlias, Class entityJavaType, String attributePath)	Deprecated. Use ResultSetMapping, or similar approach pending the outcome of this Jakarta Persistence request.
NativeQuery<T>	addAttributeResult(String columnAlias, String entityName, String attributePath)	Deprecated. Use ResultSetMapping, or similar approach pending the outcome of this Jakarta Persistence request.
NativeQuery<T>	addEntity(Class entityType)	Deprecated. Use ResultSetMapping, or similar approach pending the outcome of this Jakarta Persistence request.
NativeQuery<T>	addEntity(String entityName)	Deprecated. Use ResultSetMapping, or similar approach pending the outcome of this Jakarta Persistence request.
NativeQuery<T>	addEntity(String tableAlias, Class entityType)	Deprecated. Use ResultSetMapping, or similar approach pending the outcome of this Jakarta Persistence request.
NativeQuery<T>	addEntity(String tableAlias, Class entityClass, LockMode lockMode)	Deprecated. Use ResultSetMapping, or similar approach pending the outcome of this Jakarta Persistence request.
NativeQuery<T>	addEntity(String tableAlias, String entityName)	Deprecated. Use ResultSetMapping, or similar approach pending the outcome of this Jakarta Persistence request.
NativeQuery<T>	addEntity(String tableAlias, String entityName, LockMode lockMode)	Deprecated. Use ResultSetMapping, or similar approach pending the outcome of this Jakarta Persistence request.
NativeQuery.FetchReturn	addFetch(String tableAlias, String ownerTableAlias, String joinPropertyName)	Deprecated. Use ResultSetMapping, or similar approach pending the outcome of this Jakarta Persistence request.
<J> NativeQuery.InstantiationResultNode<J>	addInstantiation(Class<J> targetJavaType)	Deprecated. Use ResultSetMapping, or similar approach pending the outcome of this Jakarta Persistence request.
NativeQuery<T>	addJoin(String tableAlias, String path)	Deprecated. Use ResultSetMapping, or similar approach pending the outcome of this Jakarta Persistence request.
NativeQuery<T>	addJoin(String tableAlias, String ownerTableAlias, String joinPropertyName)	Deprecated. Use ResultSetMapping, or similar approach pending the outcome of this Jakarta Persistence request.
NativeQuery<T>	addJoin(String tableAlias, String path, LockMode lockMode)	Deprecated. Use ResultSetMapping, or similar approach pending the outcome of this Jakarta Persistence request.
NativeQuery<T>	addQueryHint(String hint)	Add a database query hint to the SQL query.
NativeQuery.RootReturn	addRoot(String tableAlias, Class entityType)	Deprecated. Use ResultSetMapping, or similar approach pending the outcome of this Jakarta Persistence request.
NativeQuery.RootReturn	addRoot(String tableAlias, String entityName)	Deprecated. Use ResultSetMapping, or similar approach pending the outcome of this Jakarta Persistence request.
NativeQuery<T>	addScalar(String columnAlias)	Deprecated. Use ResultSetMapping, or similar approach pending the outcome of this Jakarta Persistence request.
NativeQuery<T>	addScalar(String columnAlias, Class javaType)	Deprecated. Use ResultSetMapping, or similar approach pending the outcome of this Jakarta Persistence request.
<C> NativeQuery<T>	addScalar(String columnAlias, Class<C> relationalJavaType, AttributeConverter<?,C> converter)	Deprecated. Use ResultSetMapping, or similar approach pending the outcome of this Jakarta Persistence request.
<C> NativeQuery<T>	addScalar(String columnAlias, Class<C> relationalJavaType, Class<? extends AttributeConverter<?,C>> converter)	Deprecated. Use ResultSetMapping, or similar approach pending the outcome of this Jakarta Persistence request.
<O,R> NativeQuery<T>	addScalar(String columnAlias, Class<O> domainJavaType, Class<R> jdbcJavaType, AttributeConverter<O,R> converter)	Deprecated. Use ResultSetMapping, or similar approach pending the outcome of this Jakarta Persistence request.
<O,R> NativeQuery<T>	addScalar(String columnAlias, Class<O> domainJavaType, Class<R> jdbcJavaType, Class<? extends AttributeConverter<O,R>> converter)	Deprecated. Use ResultSetMapping, or similar approach pending the outcome of this Jakarta Persistence request.
NativeQuery<T>	addScalar(String columnAlias, BasicDomainType type)	Deprecated. Use ResultSetMapping, or similar approach pending the outcome of this Jakarta Persistence request.
NativeQuery<T>	addScalar(String columnAlias, BasicTypeReference type)	Deprecated. Use ResultSetMapping, or similar approach pending the outcome of this Jakarta Persistence request.
NativeQuery<T>	addSynchronizedEntityClass(Class entityClass)	Add all query spaces associated with the entity with the given type.
NativeQuery<T>	addSynchronizedEntityName(String entityName)	Add all query spaces associated with the entity with the given names.
NativeQuery<T>	addSynchronizedQuerySpace(String querySpace)	Add a query space.
LockMode	getHibernateLockMode()	Get the root LockMode for the query
LockModeType	getLockMode()	Not applicable to native SQL queries, due to an unfortunate requirement of the JPA specification.
SelectionQuery<T>	setCacheable(boolean cacheable)	Enable/disable second level query (result) caching for this query.
SelectionQuery<T>	setCacheMode(CacheMode cacheMode)	Set the current CacheMode in effect for this query.
SelectionQuery<T>	setCacheRegion(String cacheRegion)	Set the name of the cache region where query results should be cached (assuming SelectionQuery.isCacheable()).
SelectionQuery<T>	setCacheRetrieveMode(CacheRetrieveMode cacheRetrieveMode)
SelectionQuery<T>	setCacheStoreMode(CacheStoreMode cacheStoreMode)
NativeQuery<T>	setComment(String comment)	Set the comment for this query.
<P> NativeQuery<T>	setConvertedParameter(int position, P value, Class<? extends AttributeConverter<P,?>> converter)
<P> NativeQuery<T>	setConvertedParameter(String name, P value, Class<? extends AttributeConverter<P,?>> converter)
SelectionQuery<T>	setFetchSize(int fetchSize)	Sets a JDBC fetch size hint for the query.
SelectionQuery<T>	setFirstResult(int startPosition)
NativeQuery<T>	setFlushMode(FlushModeType flushMode)	Deprecated.
SelectionQuery<T>	setHibernateLockMode(LockMode lockMode)	Specify the root LockMode for the query
NativeQuery<T>	setHint(String hintName, Object value)	Set a hint.
SelectionQuery<T>	setLockMode(LockModeType lockMode)	Not applicable to native SQL queries, due to an unfortunate requirement of the JPA specification.
SelectionQuery<T>	setLockScope(PessimisticLockScope lockScope)	Apply a scope to any pessimistic locking applied to the query.
SelectionQuery<T>	setMaxResults(int maxResults)
NativeQuery<T>	setParameter(int position, Object value)	Bind the given argument to an ordinal query parameter.
NativeQuery<T>	setParameter(int position, Instant value, TemporalType temporalType)	Deprecated.
NativeQuery<T>	setParameter(int position, Calendar value, TemporalType temporalType)	Deprecated.
NativeQuery<T>	setParameter(int position, Date value, TemporalType temporalType)	Deprecated.
<P> NativeQuery<T>	setParameter(int position, P val, Type<P> type)	Bind the given argument to an ordinal query parameter using the given Type.
<P> NativeQuery<T>	setParameter(int position, P val, Class<P> type)	Bind the given argument to an ordinal query parameter using the given Class reference to attempt to infer the Type.
NativeQuery<T>	setParameter(Parameter<Calendar> param, Calendar value, TemporalType temporalType)	Deprecated.
NativeQuery<T>	setParameter(Parameter<Date> param, Date value, TemporalType temporalType)	Deprecated.
<P> NativeQuery<T>	setParameter(Parameter<P> param, P value)
NativeQuery<T>	setParameter(String name, Object value)	Bind the given argument to a named query parameter.
NativeQuery<T>	setParameter(String name, Instant value, TemporalType temporalType)	Deprecated.
NativeQuery<T>	setParameter(String name, Calendar value, TemporalType temporalType)	Deprecated.
NativeQuery<T>	setParameter(String name, Date value, TemporalType temporalType)	Deprecated.
<P> NativeQuery<T>	setParameter(String name, P val, Type<P> type)	Bind the given argument to a named query parameter using the given Type.
<P> NativeQuery<T>	setParameter(String name, P val, Class<P> type)	Bind the given argument to a named query parameter using the given Class reference to attempt to infer the Type.
<P> NativeQuery<T>	setParameter(QueryParameter<P> parameter, P val)	Bind an argument to the query parameter represented by the given QueryParameter.
<P> NativeQuery<T>	setParameter(QueryParameter<P> parameter, P val, Type<P> type)	Bind an argument to the query parameter represented by the given QueryParameter, using the given Type.
<P> NativeQuery<T>	setParameter(QueryParameter<P> parameter, P val, Class<P> type)	Bind an argument to the query parameter represented by the given QueryParameter, using the given Class reference to attempt to infer the Type to use.
NativeQuery<T>	setParameterList(int position, Object[] values)	Bind multiple arguments to an ordinal query parameter.
NativeQuery<T>	setParameterList(int position, Collection values)	Bind multiple arguments to an ordinal query parameter.
<P> NativeQuery<T>	setParameterList(int position, Collection<? extends P> values, Type<P> javaType)	Bind multiple arguments to an ordinal query parameter using the given Type.
<P> NativeQuery<T>	setParameterList(int position, Collection<? extends P> values, Class<P> type)	Bind multiple arguments to an ordinal query parameter using the given Class reference to attempt to infer the Type.
<P> NativeQuery<T>	setParameterList(int position, P[] values, Type<P> javaType)	Bind multiple arguments to an ordinal query parameter using the given Type.
<P> NativeQuery<T>	setParameterList(int position, P[] values, Class<P> javaType)	Bind multiple arguments to an ordinal query parameter using the given Class reference to attempt to infer the Type.
NativeQuery<T>	setParameterList(String name, Object[] values)	Bind multiple arguments to a named query parameter.
NativeQuery<T>	setParameterList(String name, Collection values)	Bind multiple arguments to a named query parameter.
<P> NativeQuery<T>	setParameterList(String name, Collection<? extends P> values, Type<P> type)	Bind multiple arguments to a named query parameter using the given Type.
<P> NativeQuery<T>	setParameterList(String name, Collection<? extends P> values, Class<P> type)	Bind multiple arguments to a named query parameter using the given Class reference to attempt to infer the Type If unable to infer an appropriate Type, fall back to CommonQueryContract.setParameterList(String, Collection).
<P> NativeQuery<T>	setParameterList(String name, P[] values, Type<P> type)	Bind multiple arguments to a named query parameter using the given Type.
<P> NativeQuery<T>	setParameterList(String name, P[] values, Class<P> type)	Bind multiple arguments to a named query parameter using the given Class reference to attempt to determine the Type to use.
<P> NativeQuery<T>	setParameterList(QueryParameter<P> parameter, Collection<? extends P> values)	Bind multiple arguments to the query parameter represented by the given QueryParameter.
<P> NativeQuery<T>	setParameterList(QueryParameter<P> parameter, Collection<? extends P> values, Type<P> type)	Bind multiple arguments to the query parameter represented by the given QueryParameter, using the given Type.
<P> NativeQuery<T>	setParameterList(QueryParameter<P> parameter, Collection<? extends P> values, Class<P> javaType)	Bind multiple arguments to the query parameter represented by the given QueryParameter using the given Class reference to attempt to infer the Type to use.
<P> NativeQuery<T>	setParameterList(QueryParameter<P> parameter, P[] values)	Bind multiple arguments to the query parameter represented by the given QueryParameter.
<P> NativeQuery<T>	setParameterList(QueryParameter<P> parameter, P[] values, Type<P> type)	Bind multiple arguments to the query parameter represented by the given QueryParameter, using the given the Type.
<P> NativeQuery<T>	setParameterList(QueryParameter<P> parameter, P[] values, Class<P> javaType)	Bind multiple arguments to the query parameter represented by the given QueryParameter using the given Class reference to attempt to infer the Type to use.
NativeQuery<T>	setProperties(Object bean)	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.
NativeQuery<T>	setProperties(Map bean)	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.
NativeQuery<T>	setQueryFlushMode(QueryFlushMode queryFlushMode)	Set the QueryFlushMode to use for this query.
NativeQuery<T>	setQueryPlanCacheable(boolean queryPlanCacheable)	Enable/disable query plan caching for this query.
SelectionQuery<T>	setReadOnly(boolean readOnly)	Set the read-only/modifiable mode for entities and proxies loaded by this Query.
SelectionQuery<T>	setResultListTransformer(ResultListTransformer<T> transformer)	Set a ResultListTransformer.
NativeQuery<T>	setTimeout(int timeout)	Apply a timeout to the corresponding database query.
NativeQuery<T>	setTimeout(Timeout timeout)	Apply a timeout to the corresponding database query.
NativeQuery<T>	setTimeout(Integer timeout)	Apply a timeout to the corresponding database query.
<X> SelectionQuery<X>	setTupleTransformer(TupleTransformer<X> transformer)	Set a TupleTransformer.

Methods inherited from interface CommonQueryContract

asMutationQuery, asSelectionQuery, asSelectionQuery, asSelectionQuery, getComment, getEffectiveFlushMode, getParameterMetadata, getQueryFlushMode, getSession, getTimeout

Methods inherited from interface MutationQuery

executeUpdate, getMutationString, getTargetType

Methods inherited from interface Query

getHints, getParameter, getParameter, getParameter, getParameter, getParameters, getParameterValue, getParameterValue, getParameterValue, isBound, unwrap

Methods inherited from interface Query

asSelectionQuery, asStatement, executeUpdate, getFlushMode, getLockTimeout, getQueryOptions, getQueryString, ofType, setFollowOnLockingStrategy, withEntityGraph

Methods inherited from interface SelectionQuery

disableFetchProfile, enableFetchProfile, getCacheMode, getCacheRegion, getCacheRetrieveMode, getCacheStoreMode, getFetchSize, getKeyedResultList, getResultCount, getResultList, getResultStream, getResultType, getSingleResult, getSingleResultOrNull, isCacheable, isQueryPlanCacheable, isReadOnly, list, scroll, scroll, setEntityGraph, setEntityGraph, setFollowOnStrategy, setLockTimeout, setPage, stream, uniqueResult, uniqueResultOptional

Methods inherited from interface Statement

execute

Methods inherited from interface SynchronizeableQuery

getSynchronizedQuerySpaces

Methods inherited from interface TypedQuery

executeUpdate, getEntityGraph, getFirstResult, getLockScope, getMaxResults

Method Details

addSynchronizedQuerySpace

NativeQuery<T> addSynchronizedQuerySpace(String querySpace)

Description copied from interface: SynchronizeableQuery

Add a query space. The effect of this call is to:

• 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
• 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.

Specified by:

addSynchronizedQuerySpace in interface SynchronizeableQuery

Parameters:

querySpace - The name of the query space, usually the name of a database table.

Returns:

this, for method chaining

addSynchronizedEntityName

NativeQuery<T> addSynchronizedEntityName(String entityName)
                                  throws MappingException

Description copied from interface: SynchronizeableQuery

Add all query spaces associated with the entity with the given names.

Same as SynchronizeableQuery.addSynchronizedQuerySpace(String) for all tables mapped by the given entity.

Specified by:

addSynchronizedEntityName in interface SynchronizeableQuery

Parameters:

entityName - The name of an entity.

Returns:

this, for method chaining

Throws:

MappingException - Indicates the given name could not be resolved as an entity

addSynchronizedEntityClass

NativeQuery<T> addSynchronizedEntityClass(Class entityClass)
                                   throws MappingException

Description copied from interface: SynchronizeableQuery

Add all query spaces associated with the entity with the given type.

Same as SynchronizeableQuery.addSynchronizedQuerySpace(String) for all tables mapped by the given entity.

Specified by:

addSynchronizedEntityClass in interface SynchronizeableQuery

Parameters:

entityClass - The class of the entity.

Returns:

this, for method chaining

Throws:

MappingException - Indicates the given class could not be resolved as an entity

setTimeout

NativeQuery<T> setTimeout(Integer timeout)

Description copied from interface: Query

Apply a timeout to the corresponding database query.

Specified by:

setTimeout in interface CommonQueryContract

Specified by:

setTimeout in interface MutationQuery

Specified by:

setTimeout in interface Query

Specified by:

setTimeout in interface Query<T>

Specified by:

setTimeout in interface SelectionQuery<T>

Specified by:

setTimeout in interface Statement

Specified by:

setTimeout in interface TypedQuery<T>

See Also:

• CommonQueryContract.getTimeout()
• Timeouts
• CommonQueryContract.setTimeout(Timeout)

setQueryPlanCacheable

NativeQuery<T> setQueryPlanCacheable(boolean queryPlanCacheable)

Description copied from interface: SelectionQuery

Enable/disable query plan caching for this query.

Specified by:

setQueryPlanCacheable in interface Query<T>

Specified by:

setQueryPlanCacheable in interface SelectionQuery<T>

See Also:

• SelectionQuery.isQueryPlanCacheable()

setQueryFlushMode

NativeQuery<T> setQueryFlushMode(QueryFlushMode queryFlushMode)

Description copied from interface: CommonQueryContract

Set the QueryFlushMode to use for this query.

Specified by:

setQueryFlushMode in interface CommonQueryContract

Specified by:

setQueryFlushMode in interface MutationQuery

Specified by:

setQueryFlushMode in interface Query<T>

Specified by:

setQueryFlushMode in interface SelectionQuery<T>

See Also:

• Session.getHibernateFlushMode()

setFlushMode

@Deprecated(since="7")
NativeQuery<T> setFlushMode(FlushModeType flushMode)

Deprecated.

Description copied from interface: Query

Set the FlushModeType to use for this query.

Setting this to null ultimately indicates to use the FlushMode of the session. Use Query.setQueryFlushMode(QueryFlushMode) passing QueryFlushMode.NO_FLUSH instead to indicate that no automatic flushing should occur.

Specified by:

setFlushMode in interface MutationQuery

Specified by:

setFlushMode in interface Query

Specified by:

setFlushMode in interface Query<T>

Specified by:

setFlushMode in interface SelectionQuery<T>

Specified by:

setFlushMode in interface Statement

Specified by:

setFlushMode in interface TypedQuery<T>

See Also:

• CommonQueryContract.getQueryFlushMode()
• Query.setQueryFlushMode(QueryFlushMode)
• Session.getHibernateFlushMode()

setCacheMode

SelectionQuery<T> setCacheMode(CacheMode cacheMode)

Description copied from interface: SelectionQuery

Set the current CacheMode in effect for this query.

Set it to null to indicate that the CacheMode of the session should be used.

Specified by:

setCacheMode in interface Query<T>

Specified by:

setCacheMode in interface SelectionQuery<T>

See Also:

• SelectionQuery.getCacheMode()
• Session.setCacheMode(CacheMode)

setCacheStoreMode

SelectionQuery<T> setCacheStoreMode(CacheStoreMode cacheStoreMode)

Specified by:

setCacheStoreMode in interface Query

Specified by:

setCacheStoreMode in interface Query<T>

Specified by:

setCacheStoreMode in interface SelectionQuery<T>

Specified by:

setCacheStoreMode in interface TypedQuery<T>

See Also:

• SelectionQuery.setCacheMode(CacheMode)

setCacheRetrieveMode

SelectionQuery<T> setCacheRetrieveMode(CacheRetrieveMode cacheRetrieveMode)

Specified by:

setCacheRetrieveMode in interface Query

Specified by:

setCacheRetrieveMode in interface Query<T>

Specified by:

setCacheRetrieveMode in interface SelectionQuery<T>

Specified by:

setCacheRetrieveMode in interface TypedQuery<T>

See Also:

• SelectionQuery.setCacheMode(CacheMode)

setCacheable

SelectionQuery<T> setCacheable(boolean cacheable)

Description copied from interface: SelectionQuery

Enable/disable second level query (result) caching for this query.

Specified by:

setCacheable in interface Query<T>

Specified by:

setCacheable in interface SelectionQuery<T>

See Also:

• SelectionQuery.isCacheable()

setCacheRegion

SelectionQuery<T> setCacheRegion(String cacheRegion)

Description copied from interface: SelectionQuery

Set the name of the cache region where query results should be cached (assuming SelectionQuery.isCacheable()). null indicates to use the default region.

Specified by:

setCacheRegion in interface Query<T>

Specified by:

setCacheRegion in interface SelectionQuery<T>

See Also:

• SelectionQuery.getCacheRegion()

setTimeout

NativeQuery<T> setTimeout(int timeout)

Description copied from interface: Query

Apply a timeout to the corresponding database query.

Specified by:

setTimeout in interface CommonQueryContract

Specified by:

setTimeout in interface MutationQuery

Specified by:

setTimeout in interface Query<T>

Specified by:

setTimeout in interface SelectionQuery<T>

See Also:

• CommonQueryContract.getTimeout()
• Timeouts
• CommonQueryContract.setTimeout(Timeout)

setFetchSize

SelectionQuery<T> setFetchSize(int fetchSize)

Description copied from interface: SelectionQuery

Sets a JDBC fetch size hint for the query.

Specified by:

setFetchSize in interface Query<T>

Specified by:

setFetchSize in interface SelectionQuery<T>

Parameters:

fetchSize - the fetch size hint

Returns:

this, for method chaining

See Also:

• SelectionQuery.getFetchSize()
• JdbcSettings.STATEMENT_FETCH_SIZE

setReadOnly

SelectionQuery<T> setReadOnly(boolean readOnly)

Description copied from interface: SelectionQuery

Set the read-only/modifiable mode for entities and proxies loaded by this Query. This setting overrides the default setting for the persistence context, Session.isDefaultReadOnly().

To set the default read-only/modifiable setting used for entities and proxies that are loaded into the session, use Session.setDefaultReadOnly(boolean).

Read-only entities are not dirty-checked and snapshots of persistent state are not maintained. Read-only entities can be modified, but changes are not persisted.

When a proxy is initialized, the loaded entity will have the same read-only/modifiable setting as the uninitialized proxy has, regardless of the session's current setting.

The read-only/modifiable setting has no impact on entities/proxies returned by the query that existed in the session beforeQuery the query was executed.

Specified by:

setReadOnly in interface Query<T>

Specified by:

setReadOnly in interface SelectionQuery<T>

Parameters:

readOnly - 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

Returns:

this, for method chaining

setComment

NativeQuery<T> setComment(String comment)

Description copied from interface: Query

Set the comment for this query.

If SQL commenting is enabled, the comment will be added to the SQL query sent to the database, which may be useful for identifying the source of troublesome queries.

SQL commenting may be enabled using the configuration property "hibernate.use_sql_comments".

Specified by:

setComment in interface CommonQueryContract

Specified by:

setComment in interface MutationQuery

Specified by:

setComment in interface Query<T>

Specified by:

setComment in interface SelectionQuery<T>

See Also:

• CommonQueryContract.getComment()

addQueryHint

NativeQuery<T> addQueryHint(String hint)

Description copied from interface: Query

Add a database query hint to the SQL query.

Multiple query hints may be specified. The operation Dialect.getQueryHintString(String, List) determines how the hint is actually added to the SQL query.

Specified by:

addQueryHint in interface CommonQueryContract

Specified by:

addQueryHint in interface Query<T>

setMaxResults

SelectionQuery<T> setMaxResults(int maxResults)

Description copied from interface: SelectionQuery

Specified by:

setMaxResults in interface Query

Specified by:

setMaxResults in interface Query<T>

Specified by:

setMaxResults in interface SelectionQuery<T>

Specified by:

setMaxResults in interface TypedQuery<T>

setFirstResult

SelectionQuery<T> setFirstResult(int startPosition)

Description copied from interface: SelectionQuery

Specified by:

setFirstResult in interface Query

Specified by:

setFirstResult in interface Query<T>

Specified by:

setFirstResult in interface SelectionQuery<T>

Specified by:

setFirstResult in interface TypedQuery<T>

setHint

NativeQuery<T> setHint(String hintName,
 Object value)

Description copied from interface: Query

Set a hint. Hints are a JPA-standard way to control provider-specific behavior affecting execution of the query. Clients of native Hibernate API should make use of type-safe operations of this interface and of its subtypes. For example, SelectionQuery.setCacheRegion(String) is preferred over HibernateHints.HINT_CACHE_REGION.

The hints understood by Hibernate are enumerated by AvailableHints.

Specified by:

setHint in interface CommonQueryContract

Specified by:

setHint in interface MutationQuery

Specified by:

setHint in interface Query

Specified by:

setHint in interface Query<T>

Specified by:

setHint in interface SelectionQuery<T>

Specified by:

setHint in interface Statement

Specified by:

setHint in interface TypedQuery<T>

See Also:

• HibernateHints
• SpecHints

getLockMode

LockModeType getLockMode()

Not applicable to native SQL queries, due to an unfortunate requirement of the JPA specification.

Use getHibernateLockMode() to obtain the lock mode.

Specified by:

getLockMode in interface Query

Specified by:

getLockMode in interface SelectionQuery<T>

Specified by:

getLockMode in interface TypedQuery<T>

Throws:

IllegalStateException - as required by JPA

See Also:

• SelectionQuery.getHibernateLockMode()

getHibernateLockMode

LockMode getHibernateLockMode()

Description copied from interface: SelectionQuery

Get the root LockMode for the query

Specified by:

getHibernateLockMode in interface Query<T>

Specified by:

getHibernateLockMode in interface SelectionQuery<T>

See Also:

• SelectionQuery.getLockMode()

setLockMode

SelectionQuery<T> setLockMode(LockModeType lockMode)

Not applicable to native SQL queries, due to an unfortunate requirement of the JPA specification.

Use setHibernateLockMode(LockMode) or the hint named "org.hibernate.lockMode" to set the lock mode.

Specified by:

setLockMode in interface Query

Specified by:

setLockMode in interface Query<T>

Specified by:

setLockMode in interface SelectionQuery<T>

Specified by:

setLockMode in interface TypedQuery<T>

Throws:

IllegalStateException - as required by JPA

See Also:

• SelectionQuery.setHibernateLockMode(LockMode)

setHibernateLockMode

SelectionQuery<T> setHibernateLockMode(LockMode lockMode)

Description copied from interface: SelectionQuery

Specify the root LockMode for the query

Specified by:

setHibernateLockMode in interface Query<T>

Specified by:

setHibernateLockMode in interface SelectionQuery<T>

See Also:

• SelectionQuery.setLockMode(LockModeType)

setTimeout

NativeQuery<T> setTimeout(Timeout timeout)

Apply a timeout to the corresponding database query.

Specified by:

setTimeout in interface CommonQueryContract

Specified by:

setTimeout in interface MutationQuery

Specified by:

setTimeout in interface Query

Specified by:

setTimeout in interface Query<T>

Specified by:

setTimeout in interface SelectionQuery<T>

Specified by:

setTimeout in interface Statement

Specified by:

setTimeout in interface TypedQuery<T>

Parameters:

timeout - The timeout to apply

Returns:

this, for method chaining

setLockScope

SelectionQuery<T> setLockScope(PessimisticLockScope lockScope)

Apply a scope to any pessimistic locking applied to the query.

Specified by:

setLockScope in interface Query<T>

Specified by:

setLockScope in interface SelectionQuery<T>

Specified by:

setLockScope in interface TypedQuery<T>

Parameters:

lockScope - The lock scope to apply

Returns:

this, for method chaining

setTupleTransformer

<X> SelectionQuery<X> setTupleTransformer(TupleTransformer<X> transformer)

Description copied from interface: SelectionQuery

Set a TupleTransformer.

Specified by:

setTupleTransformer in interface Query<T>

Specified by:

setTupleTransformer in interface SelectionQuery<T>

setResultListTransformer

SelectionQuery<T> setResultListTransformer(ResultListTransformer<T> transformer)

Description copied from interface: SelectionQuery

Set a ResultListTransformer.

Specified by:

setResultListTransformer in interface Query<T>

Specified by:

setResultListTransformer in interface SelectionQuery<T>

setParameter

NativeQuery<T> setParameter(String name,
 Object value)

Description copied from interface: Query

Bind the given argument to a named query parameter.

If the type of the parameter cannot be inferred from the context in which it occurs, use one of the overloads which accepts a "type", or pass a TypedParameterValue.

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface MutationQuery

Specified by:

setParameter in interface Query

Specified by:

setParameter in interface Query<T>

Specified by:

setParameter in interface SelectionQuery<T>

Specified by:

setParameter in interface Statement

Specified by:

setParameter in interface TypedQuery<T>

See Also:

• CommonQueryContract.setParameter(String, Object, Class)
• CommonQueryContract.setParameter(String, Object, Type)
• CommonQueryContract.setParameter(int, Object)
• TypedParameterValue

setParameter

<P> NativeQuery<T> setParameter(String name,
 P val,
 Class<P> type)

Description copied from interface: Query

Bind the given argument to a named query parameter using the given Class reference to attempt to infer the Type. If unable to infer an appropriate Type, fall back to CommonQueryContract.setParameter(String, Object).

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface MutationQuery

Specified by:

setParameter in interface Query

Specified by:

setParameter in interface Query<T>

Specified by:

setParameter in interface SelectionQuery<T>

Specified by:

setParameter in interface Statement

Specified by:

setParameter in interface TypedQuery<T>

See Also:

• CommonQueryContract.setParameter(String, Object, Type)
• CommonQueryContract.setParameter(int, Object, Class)

setParameter

<P> NativeQuery<T> setParameter(String name,
 P val,
 Type<P> type)

Description copied from interface: Query

Bind the given argument to a named query parameter using the given Type.

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface MutationQuery

Specified by:

setParameter in interface Query

Specified by:

setParameter in interface Query<T>

Specified by:

setParameter in interface SelectionQuery<T>

Specified by:

setParameter in interface Statement

Specified by:

setParameter in interface TypedQuery<T>

setParameter

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

Deprecated.

Description copied from interface: Query

Bind an Instant value to the named Query parameter using just the portion indicated by the given TemporalType.

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface MutationQuery

Specified by:

setParameter in interface Query<T>

Specified by:

setParameter in interface SelectionQuery<T>

setParameter

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

Deprecated.

Description copied from interface: Query

Query override

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface MutationQuery

Specified by:

setParameter in interface Query

Specified by:

setParameter in interface Query<T>

Specified by:

setParameter in interface SelectionQuery<T>

Specified by:

setParameter in interface Statement

Specified by:

setParameter in interface TypedQuery<T>

See Also:

• Query.setParameter(String, Calendar, TemporalType)

setParameter

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

Deprecated.

Description copied from interface: Query

Query override

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface MutationQuery

Specified by:

setParameter in interface Query

Specified by:

setParameter in interface Query<T>

Specified by:

setParameter in interface SelectionQuery<T>

Specified by:

setParameter in interface Statement

Specified by:

setParameter in interface TypedQuery<T>

See Also:

• Query.setParameter(String, Date, TemporalType)

setParameter

NativeQuery<T> setParameter(int position,
 Object value)

Description copied from interface: Query

Bind the given argument to an ordinal query parameter.

If the type of the parameter cannot be inferred from the context in which it occurs, use one of the overloads which accepts a "type", or pass a TypedParameterValue.

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface MutationQuery

Specified by:

setParameter in interface Query

Specified by:

setParameter in interface Query<T>

Specified by:

setParameter in interface SelectionQuery<T>

Specified by:

setParameter in interface Statement

Specified by:

setParameter in interface TypedQuery<T>

See Also:

• CommonQueryContract.setParameter(int, Object, Class)
• CommonQueryContract.setParameter(int, Object, Type)
• CommonQueryContract.setParameter(String, Object)
• TypedParameterValue

setParameter

<P> NativeQuery<T> setParameter(int position,
 P val,
 Class<P> type)

Description copied from interface: Query

Bind the given argument to an ordinal query parameter using the given Class reference to attempt to infer the Type. If unable to infer an appropriate Type, fall back to CommonQueryContract.setParameter(int, Object).

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface MutationQuery

Specified by:

setParameter in interface Query

Specified by:

setParameter in interface Query<T>

Specified by:

setParameter in interface SelectionQuery<T>

Specified by:

setParameter in interface Statement

Specified by:

setParameter in interface TypedQuery<T>

See Also:

• CommonQueryContract.setParameter(int, Object, Type)

setParameter

<P> NativeQuery<T> setParameter(int position,
 P val,
 Type<P> type)

Description copied from interface: Query

Bind the given argument to an ordinal query parameter using the given Type.

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface MutationQuery

Specified by:

setParameter in interface Query

Specified by:

setParameter in interface Query<T>

Specified by:

setParameter in interface SelectionQuery<T>

Specified by:

setParameter in interface Statement

Specified by:

setParameter in interface TypedQuery<T>

setParameter

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

Deprecated.

Description copied from interface: Query

Bind an Instant value to the ordinal Query parameter using just the portion indicated by the given TemporalType.

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface MutationQuery

Specified by:

setParameter in interface Query<T>

Specified by:

setParameter in interface SelectionQuery<T>

setParameter

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

Deprecated.

Description copied from interface: Query

Query override

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface MutationQuery

Specified by:

setParameter in interface Query

Specified by:

setParameter in interface Query<T>

Specified by:

setParameter in interface SelectionQuery<T>

Specified by:

setParameter in interface Statement

Specified by:

setParameter in interface TypedQuery<T>

See Also:

• Query.setParameter(int, Calendar, TemporalType)

setParameter

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

Deprecated.

Description copied from interface: Query

Query override

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface MutationQuery

Specified by:

setParameter in interface Query

Specified by:

setParameter in interface Query<T>

Specified by:

setParameter in interface SelectionQuery<T>

Specified by:

setParameter in interface Statement

Specified by:

setParameter in interface TypedQuery<T>

See Also:

• Query.setParameter(int, Date, TemporalType)

setParameter

<P> NativeQuery<T> setParameter(QueryParameter<P> parameter,
 P val)

Description copied from interface: Query

Bind an argument to the query parameter represented by the given QueryParameter.

If the type of the parameter cannot be inferred from the context in which it occurs, use one of the overloads which accepts a "type".

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface MutationQuery

Specified by:

setParameter in interface Query<T>

Specified by:

setParameter in interface SelectionQuery<T>

Parameters:

parameter - the query parameter memento

val - the argument, which might be null

Returns:

this, for method chaining

See Also:

• CommonQueryContract.setParameter(QueryParameter, Object, Type)

setParameter

<P> NativeQuery<T> setParameter(QueryParameter<P> parameter,
 P val,
 Class<P> type)

Description copied from interface: Query

Bind an argument to the query parameter represented by the given QueryParameter, using the given Class reference to attempt to infer the Type to use. If unable to infer an appropriate Type, fall back to CommonQueryContract.setParameter(QueryParameter, Object).

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface MutationQuery

Specified by:

setParameter in interface Query<T>

Specified by:

setParameter in interface SelectionQuery<T>

Parameters:

parameter - the query parameter memento

val - the argument, which might be null

type - a Type representing the type of the parameter

Returns:

this, for method chaining

See Also:

• CommonQueryContract.setParameter(QueryParameter, Object, Type)

setParameter

<P> NativeQuery<T> setParameter(QueryParameter<P> parameter,
 P val,
 Type<P> type)

Description copied from interface: Query

Bind an argument to the query parameter represented by the given QueryParameter, using the given Type.

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface MutationQuery

Specified by:

setParameter in interface Query<T>

Specified by:

setParameter in interface SelectionQuery<T>

Parameters:

parameter - the query parameter memento

val - the argument, which might be null

type - a Type representing the type of the parameter

Returns:

this, for method chaining

setParameter

<P> NativeQuery<T> setParameter(Parameter<P> param,
 P value)

Description copied from interface: Query

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface MutationQuery

Specified by:

setParameter in interface Query

Specified by:

setParameter in interface Query<T>

Specified by:

setParameter in interface SelectionQuery<T>

Specified by:

setParameter in interface Statement

Specified by:

setParameter in interface TypedQuery<T>

See Also:

• Query.setParameter(Parameter, Object)

setParameter

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

Deprecated.

Description copied from interface: Query

Query override

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface MutationQuery

Specified by:

setParameter in interface Query

Specified by:

setParameter in interface Query<T>

Specified by:

setParameter in interface SelectionQuery<T>

Specified by:

setParameter in interface Statement

Specified by:

setParameter in interface TypedQuery<T>

See Also:

• Query.setParameter(Parameter, Calendar, TemporalType)

setParameter

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

Deprecated.

Description copied from interface: Query

Query override

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface MutationQuery

Specified by:

setParameter in interface Query

Specified by:

setParameter in interface Query<T>

Specified by:

setParameter in interface SelectionQuery<T>

Specified by:

setParameter in interface Statement

Specified by:

setParameter in interface TypedQuery<T>

See Also:

• Query.setParameter(Parameter, Date, TemporalType)

setProperties

NativeQuery<T> setProperties(Object bean)

Description copied from interface: Query

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.

Specified by:

setProperties in interface CommonQueryContract

Specified by:

setProperties in interface MutationQuery

Specified by:

setProperties in interface Query<T>

Specified by:

setProperties in interface SelectionQuery<T>

Parameters:

bean - any JavaBean or POJO

Returns:

this, for method chaining

setProperties

NativeQuery<T> setProperties(Map bean)

Description copied from interface: Query

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.

Specified by:

setProperties in interface CommonQueryContract

Specified by:

setProperties in interface MutationQuery

Specified by:

setProperties in interface Query<T>

Specified by:

setProperties in interface SelectionQuery<T>

Parameters:

bean - a Map of names to arguments

Returns:

this, for method chaining

setConvertedParameter

<P> NativeQuery<T> setConvertedParameter(String name,
 P value,
 Class<? extends AttributeConverter<P,?>> converter)

Description copied from interface: Query

Specified by:

setConvertedParameter in interface CommonQueryContract

Specified by:

setConvertedParameter in interface MutationQuery

Specified by:

setConvertedParameter in interface Query

Specified by:

setConvertedParameter in interface Query<T>

Specified by:

setConvertedParameter in interface SelectionQuery<T>

Specified by:

setConvertedParameter in interface Statement

Specified by:

setConvertedParameter in interface TypedQuery<T>

See Also:

• Query.setConvertedParameter(String, Object, Class)

setConvertedParameter

<P> NativeQuery<T> setConvertedParameter(int position,
 P value,
 Class<? extends AttributeConverter<P,?>> converter)

Description copied from interface: Query

Specified by:

setConvertedParameter in interface CommonQueryContract

Specified by:

setConvertedParameter in interface MutationQuery

Specified by:

setConvertedParameter in interface Query

Specified by:

setConvertedParameter in interface Query<T>

Specified by:

setConvertedParameter in interface SelectionQuery<T>

Specified by:

setConvertedParameter in interface Statement

Specified by:

setConvertedParameter in interface TypedQuery<T>

See Also:

• Query.setConvertedParameter(int, Object, Class)

setParameterList

NativeQuery<T> setParameterList(String name,
 Collection values)

Description copied from interface: Query

Bind multiple arguments to a named query parameter.

The "type mapping" for the binding is inferred from the type of the first collection element.

Specified by:

setParameterList in interface CommonQueryContract

Specified by:

setParameterList in interface MutationQuery

Specified by:

setParameterList in interface Query<T>

Specified by:

setParameterList in interface SelectionQuery<T>

Returns:

this, for method chaining

See Also:

• CommonQueryContract.setParameterList(java.lang.String, java.util.Collection, Type)

setParameterList

<P> NativeQuery<T> setParameterList(String name,
 Collection<? extends P> values,
 Class<P> type)

Description copied from interface: Query

Bind multiple arguments to a named query parameter using the given Class reference to attempt to infer the Type If unable to infer an appropriate Type, fall back to CommonQueryContract.setParameterList(String, Collection).

Specified by:

setParameterList in interface CommonQueryContract

Specified by:

setParameterList in interface MutationQuery

Specified by:

setParameterList in interface Query<T>

Specified by:

setParameterList in interface SelectionQuery<T>

Returns:

this, for method chaining

See Also:

• CommonQueryContract.setParameterList(java.lang.String, java.util.Collection, Type)

setParameterList

<P> NativeQuery<T> setParameterList(String name,
 Collection<? extends P> values,
 Type<P> type)

Description copied from interface: Query

Bind multiple arguments to a named query parameter using the given Type.

Specified by:

setParameterList in interface CommonQueryContract

Specified by:

setParameterList in interface MutationQuery

Specified by:

setParameterList in interface Query<T>

Specified by:

setParameterList in interface SelectionQuery<T>

Returns:

this, for method chaining

setParameterList

NativeQuery<T> setParameterList(String name,
 Object[] values)

Description copied from interface: Query

Bind multiple arguments to a named query parameter.

The "type mapping" for the binding is inferred from the type of the first collection element

Specified by:

setParameterList in interface CommonQueryContract

Specified by:

setParameterList in interface MutationQuery

Specified by:

setParameterList in interface Query<T>

Specified by:

setParameterList in interface SelectionQuery<T>

Returns:

this, for method chaining

setParameterList

<P> NativeQuery<T> setParameterList(String name,
 P[] values,
 Class<P> type)

Description copied from interface: Query

Bind multiple arguments to a named query parameter using the given Class reference to attempt to determine the Type to use. If unable to determine an appropriate Type, CommonQueryContract.setParameterList(String, Collection) is used

Specified by:

setParameterList in interface CommonQueryContract

Specified by:

setParameterList in interface MutationQuery

Specified by:

setParameterList in interface Query<T>

Specified by:

setParameterList in interface SelectionQuery<T>

Returns:

this, for method chaining

See Also:

• CommonQueryContract.setParameterList(java.lang.String, Object[], Type)

setParameterList

<P> NativeQuery<T> setParameterList(String name,
 P[] values,
 Type<P> type)

Description copied from interface: Query

Bind multiple arguments to a named query parameter using the given Type.

Specified by:

setParameterList in interface CommonQueryContract

Specified by:

setParameterList in interface MutationQuery

Specified by:

setParameterList in interface Query<T>

Specified by:

setParameterList in interface SelectionQuery<T>

Returns:

this, for method chaining

setParameterList

NativeQuery<T> setParameterList(int position,
 Collection values)

Description copied from interface: Query

Bind multiple arguments to an ordinal query parameter.

The "type mapping" for the binding is inferred from the type of the first collection element

Specified by:

setParameterList in interface CommonQueryContract

Specified by:

setParameterList in interface MutationQuery

Specified by:

setParameterList in interface Query<T>

Specified by:

setParameterList in interface SelectionQuery<T>

Returns:

this, for method chaining

setParameterList

<P> NativeQuery<T> setParameterList(int position,
 Collection<? extends P> values,
 Class<P> type)

Description copied from interface: Query

Bind multiple arguments to an ordinal query parameter using the given Class reference to attempt to infer the Type. If unable to infer an appropriate Type, fall back to CommonQueryContract.setParameterList(String, Collection).

Specified by:

setParameterList in interface CommonQueryContract

Specified by:

setParameterList in interface MutationQuery

Specified by:

setParameterList in interface Query<T>

Specified by:

setParameterList in interface SelectionQuery<T>

Returns:

this, for method chaining

See Also:

• CommonQueryContract.setParameterList(int, Collection, Type)

setParameterList

<P> NativeQuery<T> setParameterList(int position,
 Collection<? extends P> values,
 Type<P> javaType)

Description copied from interface: Query

Bind multiple arguments to an ordinal query parameter using the given Type.

Specified by:

setParameterList in interface CommonQueryContract

Specified by:

setParameterList in interface MutationQuery

Specified by:

setParameterList in interface Query<T>

Specified by:

setParameterList in interface SelectionQuery<T>

Returns:

this, for method chaining

setParameterList

NativeQuery<T> setParameterList(int position,
 Object[] values)

Description copied from interface: Query

Bind multiple arguments to an ordinal query parameter.

The "type mapping" for the binding is inferred from the type of the first collection element

Specified by:

setParameterList in interface CommonQueryContract

Specified by:

setParameterList in interface MutationQuery

Specified by:

setParameterList in interface Query<T>

Specified by:

setParameterList in interface SelectionQuery<T>

Returns:

this, for method chaining

setParameterList

<P> NativeQuery<T> setParameterList(int position,
 P[] values,
 Class<P> javaType)

Description copied from interface: Query

Bind multiple arguments to an ordinal query parameter using the given Class reference to attempt to infer the Type. If unable to infer an appropriate Type, fall back to CommonQueryContract.setParameterList(String, Collection).

Specified by:

setParameterList in interface CommonQueryContract

Specified by:

setParameterList in interface MutationQuery

Specified by:

setParameterList in interface Query<T>

Specified by:

setParameterList in interface SelectionQuery<T>

Returns:

this, for method chaining

See Also:

• CommonQueryContract.setParameterList(int, Object[], Type)

setParameterList

<P> NativeQuery<T> setParameterList(int position,
 P[] values,
 Type<P> javaType)

Description copied from interface: Query

Bind multiple arguments to an ordinal query parameter using the given Type.

Specified by:

setParameterList in interface CommonQueryContract

Specified by:

setParameterList in interface MutationQuery

Specified by:

setParameterList in interface Query<T>

Specified by:

setParameterList in interface SelectionQuery<T>

Returns:

this, for method chaining

setParameterList

<P> NativeQuery<T> setParameterList(QueryParameter<P> parameter,
 Collection<? extends P> values)

Description copied from interface: Query

Bind multiple arguments to the query parameter represented by the given QueryParameter.

The type of the parameter is inferred from the context in which it occurs, and from the type of the first given argument.

Specified by:

setParameterList in interface CommonQueryContract

Specified by:

setParameterList in interface MutationQuery

Specified by:

setParameterList in interface Query<T>

Specified by:

setParameterList in interface SelectionQuery<T>

Parameters:

parameter - the parameter memento

values - a collection of arguments

Returns:

this, for method chaining

setParameterList

<P> NativeQuery<T> setParameterList(QueryParameter<P> parameter,
 Collection<? extends P> values,
 Class<P> javaType)

Description copied from interface: Query

Bind multiple arguments to the query parameter represented by the given QueryParameter using the given Class reference to attempt to infer the Type to use. If unable to infer an appropriate Type, fall back to using CommonQueryContract.setParameterList(String, Collection).

Specified by:

setParameterList in interface CommonQueryContract

Specified by:

setParameterList in interface MutationQuery

Specified by:

setParameterList in interface Query<T>

Specified by:

setParameterList in interface SelectionQuery<T>

Returns:

this, for method chaining

See Also:

• CommonQueryContract.setParameterList(QueryParameter, java.util.Collection, Type)

setParameterList

<P> NativeQuery<T> setParameterList(QueryParameter<P> parameter,
 Collection<? extends P> values,
 Type<P> type)

Description copied from interface: Query

Bind multiple arguments to the query parameter represented by the given QueryParameter, using the given Type.

Specified by:

setParameterList in interface CommonQueryContract

Specified by:

setParameterList in interface MutationQuery

Specified by:

setParameterList in interface Query<T>

Specified by:

setParameterList in interface SelectionQuery<T>

Returns:

this, for method chaining

setParameterList

<P> NativeQuery<T> setParameterList(QueryParameter<P> parameter,
 P[] values)

Description copied from interface: Query

Bind multiple arguments to the query parameter represented by the given QueryParameter.

The type of the parameter is inferred between the context in which it occurs, the type associated with the QueryParameter and the type of the first given argument.

Specified by:

setParameterList in interface CommonQueryContract

Specified by:

setParameterList in interface MutationQuery

Specified by:

setParameterList in interface Query<T>

Specified by:

setParameterList in interface SelectionQuery<T>

Parameters:

parameter - the parameter memento

values - a collection of arguments

Returns:

this, for method chaining

setParameterList

<P> NativeQuery<T> setParameterList(QueryParameter<P> parameter,
 P[] values,
 Class<P> javaType)

Description copied from interface: Query

Bind multiple arguments to the query parameter represented by the given QueryParameter using the given Class reference to attempt to infer the Type to use. If unable to infer an appropriate Type, fall back to using CommonQueryContract.setParameterList(String, Collection).

Specified by:

setParameterList in interface CommonQueryContract

Specified by:

setParameterList in interface MutationQuery

Specified by:

setParameterList in interface Query<T>

Specified by:

setParameterList in interface SelectionQuery<T>

Returns:

this, for method chaining

See Also:

• CommonQueryContract.setParameterList(QueryParameter, Object[], Type)

setParameterList

<P> NativeQuery<T> setParameterList(QueryParameter<P> parameter,
 P[] values,
 Type<P> type)

Description copied from interface: Query

Bind multiple arguments to the query parameter represented by the given QueryParameter, using the given the Type.

Specified by:

setParameterList in interface CommonQueryContract

Specified by:

setParameterList in interface MutationQuery

Specified by:

setParameterList in interface Query<T>

Specified by:

setParameterList in interface SelectionQuery<T>

Returns:

this, for method chaining

addScalar

@Deprecated(since="8.0")
NativeQuery<T> addScalar(String columnAlias)

Deprecated.

Use ResultSetMapping, or similar approach pending the outcome of this Jakarta Persistence request.

Declare a scalar query result. Hibernate will attempt to automatically detect the underlying type.

Functions like <return-scalar/> in hbm.xml or ColumnResult in annotations

Parameters:

columnAlias - The column alias in the result set to be processed as a scalar result

Returns:

this, for method chaining

addScalar

@Deprecated(since="8.0")
NativeQuery<T> addScalar(String columnAlias,
 BasicTypeReference type)

Deprecated.

Use ResultSetMapping, or similar approach pending the outcome of this Jakarta Persistence request.

Declare a scalar query result.

Functions like <return-scalar/> in hbm.xml or ColumnResult in annotations.

Parameters:

columnAlias - The column alias in the result set to be processed as a scalar result

type - The Hibernate type as which to treat the value.

Returns:

this, for method chaining

addScalar

@Deprecated(since="8.0")
NativeQuery<T> addScalar(String columnAlias,
 BasicDomainType type)

Deprecated.

Use ResultSetMapping, or similar approach pending the outcome of this Jakarta Persistence request.

Declare a scalar query result.

Functions like <return-scalar/> in hbm.xml or ColumnResult in annotations.

Parameters:

columnAlias - The column alias in the result set to be processed as a scalar result

type - The Hibernate type as which to treat the value.

Returns:

this, for method chaining

addScalar

@Deprecated(since="8.0")
NativeQuery<T> addScalar(String columnAlias,
 Class javaType)

Deprecated.

Use ResultSetMapping, or similar approach pending the outcome of this Jakarta Persistence request.

Declare a scalar query result using the specified result type.

Hibernate will implicitly determine an appropriate conversion, if it can. Otherwise, an exception will be thrown.

Returns:

this, for method chaining

Since:

6.0

addScalar

@Deprecated(since="8.0")
<C> NativeQuery<T> addScalar(String columnAlias,
 Class<C> relationalJavaType,
 AttributeConverter<?,C> converter)

Deprecated.

Use ResultSetMapping, or similar approach pending the outcome of this Jakarta Persistence request.

Declare a scalar query result with an explicit conversion.

Parameters:

relationalJavaType - The Java type expected by the converter as its "relational" type.

converter - The conversion to apply. Consumes the JDBC value based on relationalJavaType.

Returns:

this, for method chaining

Since:

6.0

addScalar

@Deprecated(since="8.0")
<O,R> NativeQuery<T> addScalar(String columnAlias,
 Class<O> domainJavaType,
 Class<R> jdbcJavaType,
 AttributeConverter<O,R> converter)

Deprecated.

Use ResultSetMapping, or similar approach pending the outcome of this Jakarta Persistence request.

Declare a scalar query result with an explicit conversion.

Parameters:

domainJavaType - The Java type expected by the converter as its "object model" type.

jdbcJavaType - The Java type expected by the converter as its "relational model" type.

converter - The conversion to apply. Consumes the JDBC value based on relationalJavaType.

Returns:

this, for method chaining

Since:

6.0

addScalar

@Deprecated(since="8.0")
<C> NativeQuery<T> addScalar(String columnAlias,
 Class<C> relationalJavaType,
 Class<? extends AttributeConverter<?,C>> converter)

Deprecated.

Use ResultSetMapping, or similar approach pending the outcome of this Jakarta Persistence request.

Declare a scalar query result with an explicit conversion.

Parameters:

relationalJavaType - The Java type expected by the converter as its "relational" type.

converter - The conversion to apply. Consumes the JDBC value based on relationalJavaType.

Returns:

this, for method chaining

Since:

6.0

addScalar

@Deprecated(since="8.0")
<O,R> NativeQuery<T> addScalar(String columnAlias,
 Class<O> domainJavaType,
 Class<R> jdbcJavaType,
 Class<? extends AttributeConverter<O,R>> converter)

Deprecated.

Use ResultSetMapping, or similar approach pending the outcome of this Jakarta Persistence request.

Declare a scalar query result with an explicit conversion.

Parameters:

domainJavaType - The Java type expected by the converter as its "object model" type.

jdbcJavaType - The Java type expected by the converter as its "relational model" type.

converter - The conversion to apply. Consumes the JDBC value based on relationalJavaType.

Returns:

this, for method chaining

Since:

6.0

addInstantiation

@Deprecated(since="8.0")
<J> NativeQuery.InstantiationResultNode<J> addInstantiation(Class<J> targetJavaType)

Deprecated.

Use ResultSetMapping, or similar approach pending the outcome of this Jakarta Persistence request.

addAttributeResult

@Deprecated(since="8.0")
NativeQuery<T> addAttributeResult(String columnAlias,
 Class entityJavaType,
 String attributePath)

Deprecated.

Use ResultSetMapping, or similar approach pending the outcome of this Jakarta Persistence request.

Defines a result based on a specified attribute. Differs from adding a scalar in that any conversions or other semantics defined on the attribute are automatically applied to the mapping.

Returns:

this, for method chaining

Since:

6.0

addAttributeResult

@Deprecated(since="8.0")
NativeQuery<T> addAttributeResult(String columnAlias,
 String entityName,
 String attributePath)

Deprecated.

Use ResultSetMapping, or similar approach pending the outcome of this Jakarta Persistence request.

Defines a result based on a specified attribute. Differs from adding a scalar in that any conversions or other semantics defined on the attribute are automatically applied to the mapping.

Returns:

this, for method chaining

Since:

6.0

addAttributeResult

@Deprecated(since="8.0")
NativeQuery<T> addAttributeResult(String columnAlias,
 SingularAttribute attribute)

Deprecated.

Use ResultSetMapping, or similar approach pending the outcome of this Jakarta Persistence request.

Defines a result based on a specified attribute. Differs from adding a scalar in that any conversions or other semantics defined on the attribute are automatically applied to the mapping.

This form accepts the JPA Attribute mapping describing the attribute

Returns:

this, for method chaining

Since:

6.0

addRoot

@Deprecated(since="8.0")
NativeQuery.RootReturn addRoot(String tableAlias,
 String entityName)

Deprecated.

Use ResultSetMapping, or similar approach pending the outcome of this Jakarta Persistence request.

Add a new root return mapping, returning a NativeQuery.RootReturn to allow further definition.

Parameters:

tableAlias - The SQL table alias to map to this entity

entityName - The name of the entity

Returns:

The return config object for further control.

Since:

3.6

addRoot

@Deprecated(since="8.0")
NativeQuery.RootReturn addRoot(String tableAlias,
 Class entityType)

Deprecated.

Use ResultSetMapping, or similar approach pending the outcome of this Jakarta Persistence request.

Add a new root return mapping, returning a NativeQuery.RootReturn to allow further definition.

Parameters:

tableAlias - The SQL table alias to map to this entity

entityType - The java type of the entity

Returns:

The return config object for further control.

Since:

3.6

addEntity

@Deprecated(since="8.0")
NativeQuery<T> addEntity(String entityName)

Deprecated.

Use ResultSetMapping, or similar approach pending the outcome of this Jakarta Persistence request.

Declare a "root" entity, without specifying an alias. The expectation here is that the table alias is the same as the unqualified entity name.

Use addRoot(String, String) if you need further control of the mapping

Parameters:

entityName - The entity name that is the root return of the query

Returns:

this, for method chaining

addEntity

@Deprecated(since="8.0")
NativeQuery<T> addEntity(String tableAlias,
 String entityName)

Deprecated.

Use ResultSetMapping, or similar approach pending the outcome of this Jakarta Persistence request.

Declare a "root" entity.

Parameters:

tableAlias - The SQL table alias

entityName - The entity name

Returns:

this, for method chaining

addEntity

@Deprecated(since="8.0")
NativeQuery<T> addEntity(String tableAlias,
 String entityName,
 LockMode lockMode)

Deprecated.

Use ResultSetMapping, or similar approach pending the outcome of this Jakarta Persistence request.

Declare a "root" entity, specifying a lock mode.

Parameters:

tableAlias - The SQL table alias

entityName - The entity name

lockMode - The lock mode for this return.

Returns:

this, for method chaining

addEntity

@Deprecated(since="8.0")
NativeQuery<T> addEntity(Class entityType)

Deprecated.

Use ResultSetMapping, or similar approach pending the outcome of this Jakarta Persistence request.

Declare a "root" entity, without specifying an alias. The expectation here is that the table alias is the same as the unqualified entity name.

Parameters:

entityType - The java type of the entity to add as a root

Returns:

this, for method chaining

addEntity

@Deprecated(since="8.0")
NativeQuery<T> addEntity(String tableAlias,
 Class entityType)

Deprecated.

Use ResultSetMapping, or similar approach pending the outcome of this Jakarta Persistence request.

Declare a "root" entity.

Parameters:

tableAlias - The SQL table alias

entityType - The java type of the entity to add as a root

Returns:

this, for method chaining

addEntity

@Deprecated(since="8.0")
NativeQuery<T> addEntity(String tableAlias,
 Class entityClass,
 LockMode lockMode)

Deprecated.

Use ResultSetMapping, or similar approach pending the outcome of this Jakarta Persistence request.

Declare a "root" entity, specifying a lock mode.

Parameters:

tableAlias - The SQL table alias

entityClass - The entity Class

lockMode - The lock mode for this return

Returns:

this, for method chaining

addFetch

@Deprecated(since="8.0")
NativeQuery.FetchReturn addFetch(String tableAlias,
 String ownerTableAlias,
 String joinPropertyName)

Deprecated.

Use ResultSetMapping, or similar approach pending the outcome of this Jakarta Persistence request.

Declare a join fetch result.

Parameters:

tableAlias - The SQL table alias for the data to be mapped to this fetch.

ownerTableAlias - Identify the table alias of the owner of this association. Should match the alias of a previously added root or fetch.

joinPropertyName - The name of the property being join fetched.

Returns:

The return config object for further control.

Since:

3.6

addJoin

@Deprecated(since="8.0")
NativeQuery<T> addJoin(String tableAlias,
 String path)

Deprecated.

Use ResultSetMapping, or similar approach pending the outcome of this Jakarta Persistence request.

Declare a join fetch result.

Parameters:

tableAlias - The SQL table alias for the data to be mapped to this fetch.

path - The association path of form [owner-alias].[property-name].

Returns:

this, for method chaining

addJoin

@Deprecated(since="8.0")
NativeQuery<T> addJoin(String tableAlias,
 String ownerTableAlias,
 String joinPropertyName)

Deprecated.

Use ResultSetMapping, or similar approach pending the outcome of this Jakarta Persistence request.

Declare a join fetch result.

Parameters:

tableAlias - The SQL table alias for the data to be mapped to this fetch

ownerTableAlias - Identify the table alias of the owner of this association. Should match the alias of a previously added root or fetch.

joinPropertyName - The name of the property being join fetched.

Returns:

this, for method chaining

Since:

3.6

addJoin

@Deprecated(since="8.0")
NativeQuery<T> addJoin(String tableAlias,
 String path,
 LockMode lockMode)

Deprecated.

Use ResultSetMapping, or similar approach pending the outcome of this Jakarta Persistence request.

Declare a join fetch result, specifying a lock mode.

Parameters:

tableAlias - The SQL table alias for the data to be mapped to this fetch

path - The association path of form [owner-alias].[property-name].

lockMode - The lock mode for this return.

Returns:

this, for method chaining